<!DOCTYPE html>


<html lang="en">
<head>
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<title>Phaser CE Class: Button</title>
	<link rel="stylesheet" href="styles/site.phaser.css?2024100511">
</head>

<body>


<div class="navbar navbar-default navbar-fixed-top navbar-inverse">
  <div class="container-fluid">
  	<div class="navbar-header">
  		<a class="navbar-brand" href="index.html">Phaser CE</a>
  		<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
  			<span class="icon-bar"></span>
  			<span class="icon-bar"></span>
  			<span class="icon-bar"></span>
      </button>
  	</div>
  	<div class="navbar-collapse collapse" id="topNavigation">
  		<ul class="nav navbar-nav">
  			
  			<li class="dropdown">
  				<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
  				<ul class="dropdown-menu ">
  					<li><a href="Phaser.html">Phaser</a></li><li><a href="PhaserGlobal.html">PhaserGlobal</a></li><li><a href="PIXI.html">PIXI</a></li>
  				</ul>
  			</li>
  			
  			<li class="dropdown">
  				<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
  				<ul class="dropdown-menu ">
  					<li><a href="CreatureShader.html">CreatureShader</a></li><li><a href="EarCut.html">EarCut</a></li><li><a href="Event.html">Event</a></li><li><a href="EventTarget.html">EventTarget</a></li><li><a href="Phaser.Animation.html">Phaser.Animation</a></li><li><a href="Phaser.AnimationManager.html">Phaser.AnimationManager</a></li><li><a href="Phaser.AnimationParser.html">Phaser.AnimationParser</a></li><li><a href="Phaser.ArraySet.html">Phaser.ArraySet</a></li><li><a href="Phaser.ArrayUtils.html">Phaser.ArrayUtils</a></li><li><a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a></li><li><a href="Phaser.BitmapData.html">Phaser.BitmapData</a></li><li><a href="Phaser.BitmapText.html">Phaser.BitmapText</a></li><li><a href="Phaser.Bullet.html">Phaser.Bullet</a></li><li><a href="Phaser.Button.html">Phaser.Button</a></li><li><a href="Phaser.Cache.html">Phaser.Cache</a></li><li><a href="Phaser.Camera.html">Phaser.Camera</a></li><li><a href="Phaser.Canvas.html">Phaser.Canvas</a></li><li><a href="Phaser.CanvasPool.html">Phaser.CanvasPool</a></li><li><a href="Phaser.Circle.html">Phaser.Circle</a></li><li><a href="Phaser.Color.html">Phaser.Color</a></li><li><a href="Phaser.Component.Angle.html">Phaser.Component.Angle</a></li><li><a href="Phaser.Component.Animation.html">Phaser.Component.Animation</a></li><li><a href="Phaser.Component.AutoCull.html">Phaser.Component.AutoCull</a></li><li><a href="Phaser.Component.Bounds.html">Phaser.Component.Bounds</a></li><li><a href="Phaser.Component.BringToTop.html">Phaser.Component.BringToTop</a></li><li><a href="Phaser.Component.Core.html">Phaser.Component.Core</a></li><li><a href="Phaser.Component.Crop.html">Phaser.Component.Crop</a></li><li><a href="Phaser.Component.Delta.html">Phaser.Component.Delta</a></li><li><a href="Phaser.Component.Destroy.html">Phaser.Component.Destroy</a></li><li><a href="Phaser.Component.FixedToCamera.html">Phaser.Component.FixedToCamera</a></li><li><a href="Phaser.Component.Health.html">Phaser.Component.Health</a></li><li><a href="Phaser.Component.InCamera.html">Phaser.Component.InCamera</a></li><li><a href="Phaser.Component.InputEnabled.html">Phaser.Component.InputEnabled</a></li><li><a href="Phaser.Component.InWorld.html">Phaser.Component.InWorld</a></li><li><a href="Phaser.Component.LifeSpan.html">Phaser.Component.LifeSpan</a></li><li><a href="Phaser.Component.LoadTexture.html">Phaser.Component.LoadTexture</a></li><li><a href="Phaser.Component.Overlap.html">Phaser.Component.Overlap</a></li><li><a href="Phaser.Component.PhysicsBody.html">Phaser.Component.PhysicsBody</a></li><li><a href="Phaser.Component.Reset.html">Phaser.Component.Reset</a></li><li><a href="Phaser.Component.ScaleMinMax.html">Phaser.Component.ScaleMinMax</a></li><li><a href="Phaser.Component.Smoothed.html">Phaser.Component.Smoothed</a></li><li><a href="Phaser.Create.html">Phaser.Create</a></li><li><a href="Phaser.Creature.html">Phaser.Creature</a></li><li><a href="Phaser.Device.html">Phaser.Device</a></li><li><a href="Phaser.DeviceButton.html">Phaser.DeviceButton</a></li><li><a href="Phaser.DOM.html">Phaser.DOM</a></li><li><a href="Phaser.Easing.html">Phaser.Easing</a></li><li><a href="Phaser.Easing.Back.html">Phaser.Easing.Back</a></li><li><a href="Phaser.Easing.Bounce.html">Phaser.Easing.Bounce</a></li><li><a href="Phaser.Easing.Circular.html">Phaser.Easing.Circular</a></li><li><a href="Phaser.Easing.Cubic.html">Phaser.Easing.Cubic</a></li><li><a href="Phaser.Easing.Elastic.html">Phaser.Easing.Elastic</a></li><li><a href="Phaser.Easing.Exponential.html">Phaser.Easing.Exponential</a></li><li><a href="Phaser.Easing.Linear.html">Phaser.Easing.Linear</a></li><li><a href="Phaser.Easing.Quadratic.html">Phaser.Easing.Quadratic</a></li><li><a href="Phaser.Easing.Quartic.html">Phaser.Easing.Quartic</a></li><li><a href="Phaser.Easing.Quintic.html">Phaser.Easing.Quintic</a></li><li><a href="Phaser.Easing.Sinusoidal.html">Phaser.Easing.Sinusoidal</a></li><li><a href="Phaser.Ellipse.html">Phaser.Ellipse</a></li><li><a href="Phaser.Events.html">Phaser.Events</a></li><li><a href="Phaser.Filter.html">Phaser.Filter</a></li><li><a href="Phaser.FlexGrid.html">Phaser.FlexGrid</a></li><li><a href="Phaser.FlexLayer.html">Phaser.FlexLayer</a></li><li><a href="Phaser.Frame.html">Phaser.Frame</a></li><li><a href="Phaser.FrameData.html">Phaser.FrameData</a></li><li><a href="Phaser.Game.html">Phaser.Game</a></li><li><a href="Phaser.GameObjectCreator.html">Phaser.GameObjectCreator</a></li><li><a href="Phaser.GameObjectFactory.html">Phaser.GameObjectFactory</a></li><li><a href="Phaser.Gamepad.html">Phaser.Gamepad</a></li><li><a href="Phaser.Graphics.html">Phaser.Graphics</a></li><li><a href="Phaser.GraphicsData.html">Phaser.GraphicsData</a></li><li><a href="Phaser.Group.html">Phaser.Group</a></li><li><a href="Phaser.Hermite.html">Phaser.Hermite</a></li><li><a href="Phaser.Image.html">Phaser.Image</a></li><li><a href="Phaser.ImageCollection.html">Phaser.ImageCollection</a></li><li><a href="Phaser.Input.html">Phaser.Input</a></li><li><a href="Phaser.InputHandler.html">Phaser.InputHandler</a></li><li><a href="Phaser.Key.html">Phaser.Key</a></li><li><a href="Phaser.Keyboard.html">Phaser.Keyboard</a></li><li><a href="Phaser.KeyCode.html">Phaser.KeyCode</a></li><li><a href="Phaser.Line.html">Phaser.Line</a></li><li><a href="Phaser.LinkedList.html">Phaser.LinkedList</a></li><li><a href="Phaser.Loader.html">Phaser.Loader</a></li><li><a href="Phaser.LoaderParser.html">Phaser.LoaderParser</a></li><li><a href="Phaser.Math.html">Phaser.Math</a></li><li><a href="Phaser.Matrix.html">Phaser.Matrix</a></li><li><a href="Phaser.Mouse.html">Phaser.Mouse</a></li><li><a href="Phaser.MouseWheel.html">Phaser.MouseWheel</a></li><li><a href="Phaser.MSPointer.html">Phaser.MSPointer</a></li><li><a href="Phaser.Particle.html">Phaser.Particle</a></li><li><a href="Phaser.Particles.html">Phaser.Particles</a></li><li><a href="Phaser.Particles.Arcade.html">Phaser.Particles.Arcade</a></li><li><a href="Phaser.Particles.Arcade.Emitter.html">Phaser.Particles.Arcade.Emitter</a></li><li><a href="Phaser.Path.html">Phaser.Path</a></li><li><a href="Phaser.PathFollower.html">Phaser.PathFollower</a></li><li><a href="Phaser.PathPoint.html">Phaser.PathPoint</a></li><li><a href="Phaser.Physics.html">Phaser.Physics</a></li><li><a href="Phaser.Physics.Arcade.html">Phaser.Physics.Arcade</a></li><li><a href="Phaser.Physics.Arcade.Body.html">Phaser.Physics.Arcade.Body</a></li><li><a href="Phaser.Physics.Arcade.TilemapCollision.html">Phaser.Physics.Arcade.TilemapCollision</a></li><li><a href="Phaser.Physics.Ninja.html">Phaser.Physics.Ninja</a></li><li><a href="Phaser.Physics.Ninja.AABB.html">Phaser.Physics.Ninja.AABB</a></li><li><a href="Phaser.Physics.Ninja.Body.html">Phaser.Physics.Ninja.Body</a></li><li><a href="Phaser.Physics.Ninja.Circle.html">Phaser.Physics.Ninja.Circle</a></li><li><a href="Phaser.Physics.Ninja.Tile.html">Phaser.Physics.Ninja.Tile</a></li><li><a href="Phaser.Physics.P2.html">Phaser.Physics.P2</a></li><li><a href="Phaser.Physics.P2.Body.html">Phaser.Physics.P2.Body</a></li><li><a href="Phaser.Physics.P2.BodyDebug.html">Phaser.Physics.P2.BodyDebug</a></li><li><a href="Phaser.Physics.P2.CollisionGroup.html">Phaser.Physics.P2.CollisionGroup</a></li><li><a href="Phaser.Physics.P2.ContactMaterial.html">Phaser.Physics.P2.ContactMaterial</a></li><li><a href="Phaser.Physics.P2.DistanceConstraint.html">Phaser.Physics.P2.DistanceConstraint</a></li><li><a href="Phaser.Physics.P2.FixtureList.html">Phaser.Physics.P2.FixtureList</a></li><li><a href="Phaser.Physics.P2.GearConstraint.html">Phaser.Physics.P2.GearConstraint</a></li><li><a href="Phaser.Physics.P2.InversePointProxy.html">Phaser.Physics.P2.InversePointProxy</a></li><li><a href="Phaser.Physics.P2.LockConstraint.html">Phaser.Physics.P2.LockConstraint</a></li><li><a href="Phaser.Physics.P2.Material.html">Phaser.Physics.P2.Material</a></li><li><a href="Phaser.Physics.P2.PointProxy.html">Phaser.Physics.P2.PointProxy</a></li><li><a href="Phaser.Physics.P2.PrismaticConstraint.html">Phaser.Physics.P2.PrismaticConstraint</a></li><li><a href="Phaser.Physics.P2.RevoluteConstraint.html">Phaser.Physics.P2.RevoluteConstraint</a></li><li><a href="Phaser.Physics.P2.RotationalSpring.html">Phaser.Physics.P2.RotationalSpring</a></li><li><a href="Phaser.Physics.P2.Spring.html">Phaser.Physics.P2.Spring</a></li><li><a href="Phaser.Plugin.html">Phaser.Plugin</a></li><li><a href="Phaser.Plugin.PathManager.html">Phaser.Plugin.PathManager</a></li><li><a href="Phaser.PluginManager.html">Phaser.PluginManager</a></li><li><a href="Phaser.Point.html">Phaser.Point</a></li><li><a href="Phaser.Pointer.html">Phaser.Pointer</a></li><li><a href="Phaser.PointerLock.html">Phaser.PointerLock</a></li><li><a href="Phaser.PointerMode.html">Phaser.PointerMode</a></li><li><a href="Phaser.Polygon.html">Phaser.Polygon</a></li><li><a href="Phaser.QuadTree.html">Phaser.QuadTree</a></li><li><a href="Phaser.RandomDataGenerator.html">Phaser.RandomDataGenerator</a></li><li><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></li><li><a href="Phaser.RenderTexture.html">Phaser.RenderTexture</a></li><li><a href="Phaser.RequestAnimationFrame.html">Phaser.RequestAnimationFrame</a></li><li><a href="Phaser.RetroFont.html">Phaser.RetroFont</a></li><li><a href="Phaser.Rope.html">Phaser.Rope</a></li><li><a href="Phaser.RoundedRectangle.html">Phaser.RoundedRectangle</a></li><li><a href="Phaser.ScaleManager.html">Phaser.ScaleManager</a></li><li><a href="Phaser.Signal.html">Phaser.Signal</a></li><li><a href="Phaser.SignalBinding.html">Phaser.SignalBinding</a></li><li><a href="Phaser.SinglePad.html">Phaser.SinglePad</a></li><li><a href="Phaser.Sound.html">Phaser.Sound</a></li><li><a href="Phaser.SoundManager.html">Phaser.SoundManager</a></li><li><a href="Phaser.Sprite.html">Phaser.Sprite</a></li><li><a href="Phaser.SpriteBatch.html">Phaser.SpriteBatch</a></li><li><a href="Phaser.Stage.html">Phaser.Stage</a></li><li><a href="Phaser.State.html">Phaser.State</a></li><li><a href="Phaser.StateManager.html">Phaser.StateManager</a></li><li><a href="Phaser.Text.html">Phaser.Text</a></li><li><a href="Phaser.Tile.html">Phaser.Tile</a></li><li><a href="Phaser.Tilemap.html">Phaser.Tilemap</a></li><li><a href="Phaser.TilemapLayer.html">Phaser.TilemapLayer</a></li><li><a href="Phaser.TilemapParser.html">Phaser.TilemapParser</a></li><li><a href="Phaser.Tileset.html">Phaser.Tileset</a></li><li><a href="Phaser.TileSprite.html">Phaser.TileSprite</a></li><li><a href="Phaser.Time.html">Phaser.Time</a></li><li><a href="Phaser.Timer.html">Phaser.Timer</a></li><li><a href="Phaser.TimerEvent.html">Phaser.TimerEvent</a></li><li><a href="Phaser.Touch.html">Phaser.Touch</a></li><li><a href="Phaser.Tween.html">Phaser.Tween</a></li><li><a href="Phaser.TweenData.html">Phaser.TweenData</a></li><li><a href="Phaser.TweenManager.html">Phaser.TweenManager</a></li><li><a href="Phaser.Utils.html">Phaser.Utils</a></li><li><a href="Phaser.Utils.Debug.html">Phaser.Utils.Debug</a></li><li><a href="Phaser.Video.html">Phaser.Video</a></li><li><a href="Phaser.Weapon.html">Phaser.Weapon</a></li><li><a href="Phaser.World.html">Phaser.World</a></li><li><a href="PIXI.BaseTexture.html">PIXI.BaseTexture</a></li><li><a href="PIXI.CanvasBuffer.html">PIXI.CanvasBuffer</a></li><li><a href="PIXI.CanvasGraphics.html">PIXI.CanvasGraphics</a></li><li><a href="PIXI.CanvasMaskManager.html">PIXI.CanvasMaskManager</a></li><li><a href="PIXI.CanvasRenderer.html">PIXI.CanvasRenderer</a></li><li><a href="PIXI.CanvasTinter.html">PIXI.CanvasTinter</a></li><li><a href="PIXI.ComplexPrimitiveShader.html">PIXI.ComplexPrimitiveShader</a></li><li><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></li><li><a href="PIXI.DisplayObjectContainer.html">PIXI.DisplayObjectContainer</a></li><li><a href="PIXI.FilterTexture.html">PIXI.FilterTexture</a></li><li><a href="PIXI.PixiFastShader.html">PIXI.PixiFastShader</a></li><li><a href="PIXI.PixiShader.html">PIXI.PixiShader</a></li><li><a href="PIXI.PrimitiveShader.html">PIXI.PrimitiveShader</a></li><li><a href="PIXI.Sprite.html">PIXI.Sprite</a></li><li><a href="PIXI.StripShader.html">PIXI.StripShader</a></li><li><a href="PIXI.Texture.html">PIXI.Texture</a></li><li><a href="PIXI.WebGLBlendModeManager.html">PIXI.WebGLBlendModeManager</a></li><li><a href="PIXI.WebGLFastSpriteBatch.html">PIXI.WebGLFastSpriteBatch</a></li><li><a href="PIXI.WebGLFilterManager.html">PIXI.WebGLFilterManager</a></li><li><a href="PIXI.WebGLRenderer.html">PIXI.WebGLRenderer</a></li>
  				</ul>
  			</li>
  			
  			<li class="dropdown">
  				<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
  				<ul class="dropdown-menu ">
  					<li><a href="global.html">Global</a></li>
  				</ul>
  			</li>
  			
        <li>
  <a href="https://github.com/photonstorm/phaser-ce/blob/master/README.md">
    <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
    README
  </a>
</li>

<li>
  <a href="https://github.com/photonstorm/phaser-ce/blob/master/CHANGELOG.md">
    <span class="glyphicon glyphicon-list" aria-hidden="true"></span>
    CHANGELOG
  </a>
</li>

<li class="dropdown">
  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">
    <span class="glyphicon glyphicon-globe" aria-hidden="true"></span>
    Community
    <span class="caret"></span>
  </a>
  <ul class="dropdown-menu">
    <li>
      <a href="http://phaser.io">Phaser</a>
    </li>
    <li>
      <a href="https://github.com/photonstorm/phaser-ce">Phaser CE on GitHub</a>
    </li>
    <li>
      <a href="https://codepen.io/collection/AMbZgY/">Phaser CE Examples</a>
    </li>
    <li>
      <a href="http://www.html5gamedevs.com/forum/14-phaser/">Forum</a>
    </li>
    <li>
      <a href="https://twitter.com/photonstorm">Twitter</a>
    </li>
    <li>
      <a href="http://phaser.io/community/slack">Slack</a>
    </li>
    <li>
      <a href="http://phaser.io/community/donate">Donate</a>
    </li>
  </ul>
</li>

  		</ul>
          
  	</div>
  </div>
</div>


<div class="container-fluid" id="toc-content">
	<div class="row">
		
	  <div class="col-md-9 col-md-offset-3">
		
			<div id="main">

	<h1 class="page-title">Class: Button</h1>
<section>

<header>
    
        <h2>
            <span class="ancestors"><a href="Phaser.html">Phaser</a>.</span>
        
        Button
        </h2>
        
    
</header>


<article>
    <div class="container-overview">
    
        
<dt>
    <h4 class="name" id="Button" data-name="Button">
      <span class="type-signature"></span>new Button(game [, x] [, y] [, key] [, callback] [, callbackContext] [, overFrame] [, outFrame] [, downFrame] [, upFrame])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Create a new <code>Button</code> object. A Button is a special type of Sprite that is set-up to handle Pointer events automatically.</p>
<p>The four states a Button responds to are:</p>
<ul>
<li>'Over' - when the Pointer moves over the Button. This is also commonly known as 'hover'.</li>
<li>'Out' - when the Pointer that was previously over the Button moves out of it.</li>
<li>'Down' - when the Pointer is pressed down on the Button. I.e. touched on a touch enabled device or clicked with the mouse.</li>
<li>'Up' - when the Pointer that was pressed down on the Button is released again.</li>
</ul>
<p>A different texture/frame and activation sound can be specified for any of the states.</p>
<p>Frames can be specified as either an integer (the frame ID) or a string (the frame name); the same values that can be used with a Sprite constructor.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>game</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>Current game instance.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description param-description last"><p>X position of the Button.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description param-description last"><p>Y position of the Button.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>key</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>The image key (in the Game.Cache) to use as the texture for this Button.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>The function to call when this Button is pressed, receiving <code>this</code> (the Button), <code>pointer</code> (the Pointer causing the input), and <code>isOver</code> (whether the Pointer is still on the Button). See <a href="Phaser.Events.html#onInputUp">Phaser.Events#onInputUp</a>.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>callbackContext</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>The context in which the callback will be called (usually 'this').</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>overFrame</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>The frame / frameName when the button is in the Over state.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>outFrame</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>The frame / frameName when the button is in the Out state.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>downFrame</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>The frame / frameName when the button is in the Down state.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>upFrame</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>The frame / frameName when the button is in the Up state.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L35" title="Button on line 35 of src/gameobjects/Button.js">src/gameobjects/Button.js line 35</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

    
    </div>

    
        <h3 class="subsection-title">Extends</h3>

        


    <ul>
        <li><a href="Phaser.Image.html">Phaser.Image</a></li>
    </ul>


    

    

    

    

    

    
        <h3 class="subsection-title">Members</h3>

        <dl>
            
<dt>
    <h4 id="alive" data-name="alive">
      <span class="type-signature"></span>alive<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>A useful flag to control if the Game Object is alive or dead.</p>
<p>This is set automatically by the Health components <code>damage</code> method should the object run out of health.
Or you can toggle it via your game code.</p>
<p>This property is mostly just provided to be used by your game - it doesn't effect rendering or logic updates.
However you can use <code>Group.getFirstAlive</code> in conjunction with this property for fast object pooling and recycling.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.LifeSpan.html#alive">Phaser.Component.LifeSpan#alive</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>true</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/LifeSpan.js#L55" title="alive on line 55 of src/gameobjects/components/LifeSpan.js">src/gameobjects/components/LifeSpan.js line 55</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="alpha" data-name="alpha">
      <span class="type-signature"></span>alpha<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The alpha value of this DisplayObject. A value of 1 is fully opaque. A value of 0 is transparent.
Please note that an object with an alpha value of 0 is skipped during the render pass.</p>
<p>The value of this property does not reflect any alpha values set further up the display list.
To obtain that value please see the <code>worldAlpha</code> property.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#alpha">PIXI.DisplayObject#alpha</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>1</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L73" title="alpha on line 73 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 73</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="anchor" data-name="anchor">
      <span class="type-signature"></span>anchor<span class="type-signature"> : Point</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The anchor sets the origin point of the texture.
The default (0, 0) is the top left.
(0.5, 0.5) is the center.
(1, 1) is the bottom right.</p>
<p>You can modify the default values in PIXI.Sprite.defaultAnchor.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">Point</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.Sprite.html#anchor">PIXI.Sprite#anchor</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/Sprite.js#L28" title="anchor on line 28 of src/pixi/display/Sprite.js">src/pixi/display/Sprite.js line 28</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="angle" data-name="angle">
      <span class="type-signature"></span>angle<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The angle property is the rotation of the Game Object in <em>degrees</em> from its original orientation.</p>
<p>Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.</p>
<p>Values outside this range are added to or subtracted from 360 to obtain a value within the range.
For example, the statement player.angle = 450 is the same as player.angle = 90.</p>
<p>If you wish to work in radians instead of degrees you can use the property <code>rotation</code> instead.
Working in radians is slightly faster as it doesn't have to perform any calculations.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Angle.html#angle">Phaser.Component.Angle#angle</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Angle.js#L29" title="angle on line 29 of src/gameobjects/components/Angle.js">src/gameobjects/components/Angle.js line 29</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="animations" data-name="animations">
      <span class="type-signature"></span>animations<span class="type-signature"> : <a href="Phaser.AnimationManager.html">Phaser.AnimationManager</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>If the Game Object is enabled for animation (such as a Phaser.Sprite) this is a reference to its AnimationManager instance.
Through it you can create, play, pause and stop animations.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.AnimationManager.html">Phaser.AnimationManager</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Core.html#animations">Phaser.Component.Core#animations</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Core.js#L186" title="animations on line 186 of src/gameobjects/components/Core.js">src/gameobjects/components/Core.js line 186</a>
    

	

	
	<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
	<dd class="tag-see">
		<ul>
			<li><a href="Phaser.AnimationManager.html">Phaser.AnimationManager</a></li>
			</ul>
	</dd>
	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="autoCull" data-name="autoCull">
      <span class="type-signature"></span>autoCull<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>A Game Object with <code>autoCull</code> set to true will check its bounds against the World Camera every frame.
If it is not intersecting the Camera bounds at any point then it has its <code>renderable</code> property set to <code>false</code>.
This keeps the Game Object alive and still processing updates, but forces it to skip the render step entirely.</p>
<p>This is a relatively expensive operation, especially if enabled on hundreds of Game Objects. So enable it only if you know it's required,
or you have tested performance and find it acceptable.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.AutoCull.html#autoCull">Phaser.Component.AutoCull#autoCull</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/AutoCull.js#L28" title="autoCull on line 28 of src/gameobjects/components/AutoCull.js">src/gameobjects/components/AutoCull.js line 28</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="blendMode" data-name="blendMode">
      <span class="type-signature"></span>blendMode<span class="type-signature"> : Number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.</p>
<p>Warning: You cannot have a blend mode and a filter active on the same Sprite. Doing so will render the sprite invisible.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">Number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.Sprite.html#blendMode">PIXI.Sprite#blendMode</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>PIXI.blendModes.NORMAL;</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/Sprite.js#L93" title="blendMode on line 93 of src/pixi/display/Sprite.js">src/pixi/display/Sprite.js line 93</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="bottom" data-name="bottom">
      <span class="type-signature"></span>bottom<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The sum of the y and height properties.
This is the same as <code>y + height - offsetY</code>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Bounds.html#bottom">Phaser.Component.Bounds#bottom</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Bounds.js#L156" title="bottom on line 156 of src/gameobjects/components/Bounds.js">src/gameobjects/components/Bounds.js line 156</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="cacheAsBitmap" data-name="cacheAsBitmap">
      <span class="type-signature"></span>cacheAsBitmap<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Sets if this DisplayObject should be cached as a bitmap.</p>
<p>When invoked it will take a snapshot of the DisplayObject, as it is at that moment, and store it
in a RenderTexture. This is then used whenever this DisplayObject is rendered. It can provide a
performance benefit for complex, but static, DisplayObjects. I.e. those with lots of children.</p>
<p>Transparent areas adjoining the edges may be removed (<a href="https://github.com/photonstorm/phaser-ce/issues/283">#283</a>).</p>
<p>Cached Bitmaps do not track their parents. If you update a property of this DisplayObject, it will not
re-generate the cached bitmap automatically. To do that you need to call <code>DisplayObject.updateCache</code>.</p>
<p>To remove a cached bitmap, set this property to <code>null</code>. Cache this DisplayObject as a Bitmap. Set to <code>null</code> to remove an existing cached bitmap.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#cacheAsBitmap">PIXI.DisplayObject#cacheAsBitmap</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L791" title="cacheAsBitmap on line 791 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 791</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="cameraOffset" data-name="cameraOffset">
      <span class="type-signature"></span>cameraOffset<span class="type-signature"> : <a href="Phaser.Point.html">Phaser.Point</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The x/y coordinate offset applied to the top-left of the camera that this Game Object will be drawn at if <code>fixedToCamera</code> is true.</p>
<p>The values are relative to the top-left of the camera view and in addition to any parent of the Game Object on the display list.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.FixedToCamera.html#cameraOffset">Phaser.Component.FixedToCamera#cameraOffset</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/FixedToCamera.js#L82" title="cameraOffset on line 82 of src/gameobjects/components/FixedToCamera.js">src/gameobjects/components/FixedToCamera.js line 82</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="centerX" data-name="centerX">
      <span class="type-signature"></span>centerX<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The local center x coordinate of the Game Object.
This is the same as <code>(x - offsetX) + (width / 2)</code>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Bounds.html#centerX">Phaser.Component.Bounds#centerX</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Bounds.js#L56" title="centerX on line 56 of src/gameobjects/components/Bounds.js">src/gameobjects/components/Bounds.js line 56</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="centerY" data-name="centerY">
      <span class="type-signature"></span>centerY<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The local center y coordinate of the Game Object.
This is the same as <code>(y - offsetY) + (height / 2)</code>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Bounds.html#centerY">Phaser.Component.Bounds#centerY</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Bounds.js#L76" title="centerY on line 76 of src/gameobjects/components/Bounds.js">src/gameobjects/components/Bounds.js line 76</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="children" data-name="children">
      <span class="type-signature">&lt;readonly> </span>children<span class="type-signature"> : Array(DisplayObject)</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>[read-only] The array of children of this container.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">Array(DisplayObject)</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObjectContainer.html#children">PIXI.DisplayObjectContainer#children</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObjectContainer.js#L24" title="children on line 24 of src/pixi/display/DisplayObjectContainer.js">src/pixi/display/DisplayObjectContainer.js line 24</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="components" data-name="components">
      <span class="type-signature">&lt;protected> </span>components<span class="type-signature"> : object</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The components this Game Object has installed.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">object</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Core.html#components">Phaser.Component.Core#components</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Core.js#L160" title="components on line 160 of src/gameobjects/components/Core.js">src/gameobjects/components/Core.js line 160</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="cropRect" data-name="cropRect">
      <span class="type-signature"></span>cropRect<span class="type-signature"> : <a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The Rectangle used to crop the texture this Game Object uses.
Set this property via <code>crop</code>.
If you modify this property directly you must call <code>updateCrop</code> in order to have the change take effect.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Crop.html#cropRect">Phaser.Component.Crop#cropRect</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Crop.js#L24" title="cropRect on line 24 of src/gameobjects/components/Crop.js">src/gameobjects/components/Crop.js line 24</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="data" data-name="data">
      <span class="type-signature"></span>data<span class="type-signature"> : Object</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>An empty Object that belongs to this Game Object.
This value isn't ever used internally by Phaser, but may be used by your own code, or
by Phaser Plugins, to store data that needs to be associated with the Game Object,
without polluting the Game Object directly.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">Object</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Core.html#data">Phaser.Component.Core#data</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>{}</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Core.js#L153" title="data on line 153 of src/gameobjects/components/Core.js">src/gameobjects/components/Core.js line 153</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="debug" data-name="debug">
      <span class="type-signature"></span>debug<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>A debug flag designed for use with <code>Game.enableStep</code>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Core.html#debug">Phaser.Component.Core#debug</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Core.js#L211" title="debug on line 211 of src/gameobjects/components/Core.js">src/gameobjects/components/Core.js line 211</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="destroyPhase" data-name="destroyPhase">
      <span class="type-signature">&lt;readonly> </span>destroyPhase<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>As a Game Object runs through its destroy method this flag is set to true,
and can be checked in any sub-systems or plugins it is being destroyed from.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Destroy.html#destroyPhase">Phaser.Component.Destroy#destroyPhase</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Destroy.js#L22" title="destroyPhase on line 22 of src/gameobjects/components/Destroy.js">src/gameobjects/components/Destroy.js line 22</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="events" data-name="events">
      <span class="type-signature"></span>events<span class="type-signature"> : <a href="Phaser.Events.html">Phaser.Events</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>All Phaser Game Objects have an Events class which contains all of the events that are dispatched when certain things happen to this
Game Object, or any of its components.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Events.html">Phaser.Events</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Core.html#events">Phaser.Component.Core#events</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Core.js#L178" title="events on line 178 of src/gameobjects/components/Core.js">src/gameobjects/components/Core.js line 178</a>
    

	

	
	<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
	<dd class="tag-see">
		<ul>
			<li><a href="Phaser.Events.html">Phaser.Events</a></li>
			</ul>
	</dd>
	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="exists" data-name="exists">
      <span class="type-signature"></span>exists<span class="type-signature"> : Boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Controls if this Sprite is processed by the core Phaser game loops and Group loops (except <a href="Phaser.Group.html#update">Phaser.Group#update</a>).</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">Boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.Sprite.html#exists">PIXI.Sprite#exists</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>true</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/Sprite.js#L112" title="exists on line 112 of src/pixi/display/Sprite.js">src/pixi/display/Sprite.js line 112</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="filterArea" data-name="filterArea">
      <span class="type-signature"></span>filterArea<span class="type-signature"> : Rectangle</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The rectangular area used by filters when rendering a shader for this DisplayObject.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">Rectangle</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#filterArea">PIXI.DisplayObject#filterArea</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L205" title="filterArea on line 205 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 205</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="filters" data-name="filters">
      <span class="type-signature"></span>filters<span class="type-signature"> : Array</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Sets the filters for this DisplayObject. This is a WebGL only feature, and is ignored by the Canvas
Renderer. A filter is a shader applied to this DisplayObject. You can modify the placement of the filter
using <code>DisplayObject.filterArea</code>.</p>
<p>To remove filters, set this property to <code>null</code>.</p>
<p>Note: You cannot have a filter set, and a MULTIPLY Blend Mode active, at the same time. Setting a
filter will reset this DisplayObjects blend mode to NORMAL. An Array of Phaser.Filter objects, or objects that extend them.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">Array</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#filters">PIXI.DisplayObject#filters</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L740" title="filters on line 740 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 740</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="fixedToCamera" data-name="fixedToCamera">
      <span class="type-signature"></span>fixedToCamera<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>A Game Object that is &quot;fixed&quot; to the camera is rendered at a given x/y offsets from the top left of the camera. The offsets
are stored in the <code>cameraOffset</code> property, which is initialized with the current object coordinates.</p>
<p>The values are adjusted at the rendering stage, overriding the Game Objects actual world position.</p>
<p>The end result is that the Game Object will appear to be 'fixed' to the camera, regardless of where in the game world
the camera is viewing. This is useful if for example this Game Object is a UI item that you wish to be visible at all times
regardless where in the world the camera is.</p>
<p>Note that the <code>cameraOffset</code> values are in addition to any parent of this Game Object on the display list.</p>
<p>Be careful not to set <code>fixedToCamera</code> on Game Objects which are in Groups that already have <code>fixedToCamera</code> enabled on them.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.FixedToCamera.html#fixedToCamera">Phaser.Component.FixedToCamera#fixedToCamera</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/FixedToCamera.js#L54" title="fixedToCamera on line 54 of src/gameobjects/components/FixedToCamera.js">src/gameobjects/components/FixedToCamera.js line 54</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="forceOut" data-name="forceOut">
      <span class="type-signature"></span>forceOut<span class="type-signature"> : boolean | <a href="Phaser.PointerMode.html">Phaser.PointerMode</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>When the Button is touched / clicked and then released you can force it to enter a state of &quot;out&quot; instead of &quot;up&quot;.</p>
<p>This can also accept a pointer mode bitmask for more refined control.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>
|

<span class="param-type"><a href="Phaser.PointerMode.html">Phaser.PointerMode</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L203" title="forceOut on line 203 of src/gameobjects/Button.js">src/gameobjects/Button.js line 203</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="frame" data-name="frame">
      <span class="type-signature"></span>frame<span class="type-signature"> : integer</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Gets or sets the current frame index of the texture being used to render this Game Object.</p>
<p>To change the frame set <code>frame</code> to the index of the new frame in the sprite sheet you wish this Game Object to use,
for example: <code>player.frame = 4</code>.</p>
<p>If the frame index given doesn't exist it will revert to the first frame found in the texture.</p>
<p>If you are using a texture atlas then you should use the <code>frameName</code> property instead.</p>
<p>If you wish to fully replace the texture being used see <code>loadTexture</code>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">integer</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.LoadTexture.html#frame">Phaser.Component.LoadTexture#frame</a>
			</li>
		</ul>
	</dd>
	

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="Phaser.Image.html#frame">Phaser.Image#frame</a>
    </li></ul></dd>
    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/LoadTexture.js#L257" title="frame on line 257 of src/gameobjects/components/LoadTexture.js">src/gameobjects/components/LoadTexture.js line 257</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="frameName" data-name="frameName">
      <span class="type-signature"></span>frameName<span class="type-signature"> : string</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Gets or sets the current frame name of the texture being used to render this Game Object.</p>
<p>To change the frame set <code>frameName</code> to the name of the new frame in the texture atlas you wish this Game Object to use,
for example: <code>player.frameName = &quot;idle&quot;</code>.</p>
<p>If the frame name given doesn't exist it will revert to the first frame found in the texture and throw a console warning.</p>
<p>If you are using a sprite sheet then you should use the <code>frame</code> property instead.</p>
<p>If you wish to fully replace the texture being used see <code>loadTexture</code>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">string</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.LoadTexture.html#frameName">Phaser.Component.LoadTexture#frameName</a>
			</li>
		</ul>
	</dd>
	

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="Phaser.Image.html#frameName">Phaser.Image#frameName</a>
    </li></ul></dd>
    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/LoadTexture.js#L284" title="frameName on line 284 of src/gameobjects/components/LoadTexture.js">src/gameobjects/components/LoadTexture.js line 284</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="freezeFrames" data-name="freezeFrames">
      <span class="type-signature"></span>freezeFrames<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>When true the the texture frame will not be automatically switched on up/down/over/out events.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L193" title="freezeFrames on line 193 of src/gameobjects/Button.js">src/gameobjects/Button.js line 193</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="fresh" data-name="fresh">
      <span class="type-signature">&lt;readonly> </span>fresh<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>A Game Object is considered <code>fresh</code> if it has just been created or reset and is yet to receive a renderer transform update.
This property is mostly used internally by the physics systems, but is exposed for the use of plugins.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Core.html#fresh">Phaser.Component.Core#fresh</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Core.js#L241" title="fresh on line 241 of src/gameobjects/components/Core.js">src/gameobjects/components/Core.js line 241</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="game" data-name="game">
      <span class="type-signature"></span>game<span class="type-signature"> : <a href="Phaser.Game.html">Phaser.Game</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>A reference to the currently running Game.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Core.html#game">Phaser.Component.Core#game</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Core.js#L135" title="game on line 135 of src/gameobjects/components/Core.js">src/gameobjects/components/Core.js line 135</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="height" data-name="height">
      <span class="type-signature"></span>height<span class="type-signature"> : Number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">Number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObjectContainer.html#height">PIXI.DisplayObjectContainer#height</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObjectContainer.js#L606" title="height on line 606 of src/pixi/display/DisplayObjectContainer.js">src/pixi/display/DisplayObjectContainer.js line 606</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="hitArea" data-name="hitArea">
      <span class="type-signature"></span>hitArea<span class="type-signature"> : Rectangle | Circle | Ellipse | Polygon</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>This is the defined area that will pick up mouse / touch events. It is null by default.
Setting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">Rectangle</span>
|

<span class="param-type">Circle</span>
|

<span class="param-type">Ellipse</span>
|

<span class="param-type">Polygon</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#hitArea">PIXI.DisplayObject#hitArea</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L99" title="hitArea on line 99 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 99</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="ignoreChildInput" data-name="ignoreChildInput">
      <span class="type-signature"></span>ignoreChildInput<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>If <code>ignoreChildInput</code>  is <code>false</code> it will allow this objects <em>children</em> to be considered as valid for Input events.</p>
<p>If this property is <code>true</code> then the children will <em>not</em> be considered as valid for Input events.</p>
<p>Note that this property isn't recursive: only immediate children are influenced, it doesn't scan further down.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObjectContainer.html#ignoreChildInput">PIXI.DisplayObjectContainer#ignoreChildInput</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObjectContainer.js#L35" title="ignoreChildInput on line 35 of src/pixi/display/DisplayObjectContainer.js">src/pixi/display/DisplayObjectContainer.js line 35</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="inCamera" data-name="inCamera">
      <span class="type-signature">&lt;readonly> </span>inCamera<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Checks if the Game Objects bounds intersect with the Game Camera bounds.
Returns <code>true</code> if they do, otherwise <code>false</code> if fully outside of the Cameras bounds.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.AutoCull.html#inCamera">Phaser.Component.AutoCull#inCamera</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/AutoCull.js#L37" title="inCamera on line 37 of src/gameobjects/components/AutoCull.js">src/gameobjects/components/AutoCull.js line 37</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="input" data-name="input">
      <span class="type-signature"></span>input<span class="type-signature"> : <a href="Phaser.InputHandler.html">Phaser.InputHandler</a> | null</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The Input Handler for this Game Object.</p>
<p>By default it is disabled. If you wish this Game Object to process input events you should enable it with: <code>inputEnabled = true</code>.</p>
<p>After you have done this, this property will be a reference to the Phaser InputHandler.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.InputHandler.html">Phaser.InputHandler</a></span>
|

<span class="param-type">null</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.InputEnabled.html#input">Phaser.Component.InputEnabled#input</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/InputEnabled.js#L24" title="input on line 24 of src/gameobjects/components/InputEnabled.js">src/gameobjects/components/InputEnabled.js line 24</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="inputEnabled" data-name="inputEnabled">
      <span class="type-signature"></span>inputEnabled<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>By default a Game Object won't process any input events. By setting <code>inputEnabled</code> to true a Phaser.InputHandler is created
for this Game Object and it will then start to process click / touch events and more.</p>
<p>You can then access the Input Handler via <code>this.input</code>.</p>
<p>Note that Input related events are dispatched from <code>this.events</code>, i.e.: <code>events.onInputDown</code>.</p>
<p>If you set this property to false it will stop the Input Handler from processing any more input events.</p>
<p>If you want to <em>temporarily</em> disable input for a Game Object, then it's better to set
<code>input.enabled = false</code>, as it won't reset any of the Input Handlers internal properties.
You can then toggle this back on as needed.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.InputEnabled.html#inputEnabled">Phaser.Component.InputEnabled#inputEnabled</a>
			</li>
		</ul>
	</dd>
	

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="Phaser.Image.html#inputEnabled">Phaser.Image#inputEnabled</a>
    </li></ul></dd>
    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/InputEnabled.js#L42" title="inputEnabled on line 42 of src/gameobjects/components/InputEnabled.js">src/gameobjects/components/InputEnabled.js line 42</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="justReleasedPreventsOver" data-name="justReleasedPreventsOver">
      <span class="type-signature"></span>justReleasedPreventsOver<span class="type-signature"> : <a href="Phaser.PointerMode.html">Phaser.PointerMode</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Suppress the over event if a pointer was just released and it matches the given pointer mode bitmask.</p>
<p>This behavior was introduced in Phaser 2.3.1; this property is a soft-revert of the change.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.PointerMode.html">Phaser.PointerMode</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L186" title="justReleasedPreventsOver on line 186 of src/gameobjects/Button.js">src/gameobjects/Button.js line 186</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="key" data-name="key">
      <span class="type-signature"></span>key<span class="type-signature"> : string | <a href="Phaser.RenderTexture.html">Phaser.RenderTexture</a> | <a href="Phaser.BitmapData.html">Phaser.BitmapData</a> | <a href="Phaser.Video.html">Phaser.Video</a> | <a href="PIXI.Texture.html">PIXI.Texture</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The key of the image or texture used by this Game Object during rendering.
If it is a string it's the string used to retrieve the texture from the Phaser Image Cache.
It can also be an instance of a RenderTexture, BitmapData, Video or PIXI.Texture.
If a Game Object is created without a key it is automatically assigned the key <code>__default</code> which is a 32x32 transparent PNG stored within the Cache.
If a Game Object is given a key which doesn't exist in the Image Cache it is re-assigned the key <code>__missing</code> which is a 32x32 PNG of a green box with a line through it.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">string</span>
|

<span class="param-type"><a href="Phaser.RenderTexture.html">Phaser.RenderTexture</a></span>
|

<span class="param-type"><a href="Phaser.BitmapData.html">Phaser.BitmapData</a></span>
|

<span class="param-type"><a href="Phaser.Video.html">Phaser.Video</a></span>
|

<span class="param-type"><a href="PIXI.Texture.html">PIXI.Texture</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Core.html#key">Phaser.Component.Core#key</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Core.js#L196" title="key on line 196 of src/gameobjects/components/Core.js">src/gameobjects/components/Core.js line 196</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="left" data-name="left">
      <span class="type-signature"></span>left<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The left coordinate of the Game Object.
This is the same as <code>x - offsetX</code>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Bounds.html#left">Phaser.Component.Bounds#left</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Bounds.js#L96" title="left on line 96 of src/gameobjects/components/Bounds.js">src/gameobjects/components/Bounds.js line 96</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="lifespan" data-name="lifespan">
      <span class="type-signature"></span>lifespan<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The lifespan allows you to give a Game Object a lifespan in milliseconds.</p>
<p>Once the Game Object is 'born' you can set this to a positive value.</p>
<p>It is automatically decremented by <code>game.time.delta</code> each frame.
When it reaches zero it will call the <code>kill</code> method.</p>
<p>Very handy for particles, bullets, collectibles, or any other short-lived entity.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.LifeSpan.html#lifespan">Phaser.Component.LifeSpan#lifespan</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/LifeSpan.js#L70" title="lifespan on line 70 of src/gameobjects/components/LifeSpan.js">src/gameobjects/components/LifeSpan.js line 70</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="mask" data-name="mask">
      <span class="type-signature"></span>mask<span class="type-signature"> : <a href="Phaser.Graphics.html">Phaser.Graphics</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Sets a mask for this DisplayObject. A mask is an instance of a Graphics object.
When applied it limits the visible area of this DisplayObject to the shape of the mask.
Under a Canvas renderer it uses shape clipping. Under a WebGL renderer it uses a Stencil Buffer.
To remove a mask, set this property to <code>null</code>. The mask applied to this DisplayObject. Set to <code>null</code> to remove an existing mask.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Graphics.html">Phaser.Graphics</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#mask">PIXI.DisplayObject#mask</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L707" title="mask on line 707 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 707</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="name" data-name="name">
      <span class="type-signature"></span>name<span class="type-signature"> : string</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>A user defined name given to this Game Object.
This value isn't ever used internally by Phaser, it is meant as a game level property.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">string</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Core.html#name">Phaser.Component.Core#name</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Core.js#L143" title="name on line 143 of src/gameobjects/components/Core.js">src/gameobjects/components/Core.js line 143</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="offsetX" data-name="offsetX">
      <span class="type-signature">&lt;readonly> </span>offsetX<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The amount the Game Object is visually offset from its x coordinate.
This is the same as <code>width * anchor.x</code>.
It will only be &gt; 0 if anchor.x is not equal to zero.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Bounds.html#offsetX">Phaser.Component.Bounds#offsetX</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Bounds.js#L24" title="offsetX on line 24 of src/gameobjects/components/Bounds.js">src/gameobjects/components/Bounds.js line 24</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="offsetY" data-name="offsetY">
      <span class="type-signature">&lt;readonly> </span>offsetY<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The amount the Game Object is visually offset from its y coordinate.
This is the same as <code>height * anchor.y</code>.
It will only be &gt; 0 if anchor.y is not equal to zero.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Bounds.html#offsetY">Phaser.Component.Bounds#offsetY</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Bounds.js#L41" title="offsetY on line 41 of src/gameobjects/components/Bounds.js">src/gameobjects/components/Bounds.js line 41</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="onDownSound" data-name="onDownSound">
      <span class="type-signature">&lt;readonly> </span>onDownSound<span class="type-signature"> : <a href="Phaser.Sound.html">Phaser.Sound</a> | <a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a> | null</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The Sound to be played when this Buttons Down state is activated.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Sound.html">Phaser.Sound</a></span>
|

<span class="param-type"><a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a></span>
|

<span class="param-type">null</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L105" title="onDownSound on line 105 of src/gameobjects/Button.js">src/gameobjects/Button.js line 105</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="onDownSoundMarker" data-name="onDownSoundMarker">
      <span class="type-signature">&lt;readonly> </span>onDownSoundMarker<span class="type-signature"> : string</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The Sound Marker used in conjunction with the onDownSound.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">string</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L133" title="onDownSoundMarker on line 133 of src/gameobjects/Button.js">src/gameobjects/Button.js line 133</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="onInputDown" data-name="onInputDown">
      <span class="type-signature"></span>onInputDown<span class="type-signature"> : <a href="Phaser.Signal.html">Phaser.Signal</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The Signal (or event) dispatched when this Button is in an Down state.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L161" title="onInputDown on line 161 of src/gameobjects/Button.js">src/gameobjects/Button.js line 161</a>
    

	

	
	<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
	<dd class="tag-see">
		<ul>
			<li><a href="Phaser.Events.html#onInputDown">Phaser.Events#onInputDown</a></li>
			</ul>
	</dd>
	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="onInputOut" data-name="onInputOut">
      <span class="type-signature"></span>onInputOut<span class="type-signature"> : <a href="Phaser.Signal.html">Phaser.Signal</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The Signal (or event) dispatched when this Button is in an Out state.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L154" title="onInputOut on line 154 of src/gameobjects/Button.js">src/gameobjects/Button.js line 154</a>
    

	

	
	<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
	<dd class="tag-see">
		<ul>
			<li><a href="Phaser.Events.html#onInputOut">Phaser.Events#onInputOut</a></li>
			</ul>
	</dd>
	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="onInputOver" data-name="onInputOver">
      <span class="type-signature"></span>onInputOver<span class="type-signature"> : <a href="Phaser.Signal.html">Phaser.Signal</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The Signal (or event) dispatched when this Button is in an Over state.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L147" title="onInputOver on line 147 of src/gameobjects/Button.js">src/gameobjects/Button.js line 147</a>
    

	

	
	<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
	<dd class="tag-see">
		<ul>
			<li><a href="Phaser.Events.html#onInputOver">Phaser.Events#onInputOver</a></li>
			</ul>
	</dd>
	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="onInputUp" data-name="onInputUp">
      <span class="type-signature"></span>onInputUp<span class="type-signature"> : <a href="Phaser.Signal.html">Phaser.Signal</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The Signal (or event) dispatched when this Button is in an Up state.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L168" title="onInputUp on line 168 of src/gameobjects/Button.js">src/gameobjects/Button.js line 168</a>
    

	

	
	<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
	<dd class="tag-see">
		<ul>
			<li><a href="Phaser.Events.html#onInputUp">Phaser.Events#onInputUp</a></li>
			</ul>
	</dd>
	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="onOutSound" data-name="onOutSound">
      <span class="type-signature">&lt;readonly> </span>onOutSound<span class="type-signature"> : <a href="Phaser.Sound.html">Phaser.Sound</a> | <a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a> | null</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The Sound to be played when this Buttons Out state is activated.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Sound.html">Phaser.Sound</a></span>
|

<span class="param-type"><a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a></span>
|

<span class="param-type">null</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L98" title="onOutSound on line 98 of src/gameobjects/Button.js">src/gameobjects/Button.js line 98</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="onOutSoundMarker" data-name="onOutSoundMarker">
      <span class="type-signature">&lt;readonly> </span>onOutSoundMarker<span class="type-signature"> : string</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The Sound Marker used in conjunction with the onOutSound.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">string</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L126" title="onOutSoundMarker on line 126 of src/gameobjects/Button.js">src/gameobjects/Button.js line 126</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="onOverMouseOnly" data-name="onOverMouseOnly">
      <span class="type-signature"></span>onOverMouseOnly<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>If true then onOver events (such as onOverSound) will only be triggered if the Pointer object causing them was the Mouse Pointer.
The frame will still be changed as applicable.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>true</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L177" title="onOverMouseOnly on line 177 of src/gameobjects/Button.js">src/gameobjects/Button.js line 177</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="onOverSound" data-name="onOverSound">
      <span class="type-signature">&lt;readonly> </span>onOverSound<span class="type-signature"> : <a href="Phaser.Sound.html">Phaser.Sound</a> | <a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a> | null</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The Sound to be played when this Buttons Over state is activated.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Sound.html">Phaser.Sound</a></span>
|

<span class="param-type"><a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a></span>
|

<span class="param-type">null</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L91" title="onOverSound on line 91 of src/gameobjects/Button.js">src/gameobjects/Button.js line 91</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="onOverSoundMarker" data-name="onOverSoundMarker">
      <span class="type-signature">&lt;readonly> </span>onOverSoundMarker<span class="type-signature"> : string</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The Sound Marker used in conjunction with the onOverSound.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">string</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L119" title="onOverSoundMarker on line 119 of src/gameobjects/Button.js">src/gameobjects/Button.js line 119</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="onUpSound" data-name="onUpSound">
      <span class="type-signature">&lt;readonly> </span>onUpSound<span class="type-signature"> : <a href="Phaser.Sound.html">Phaser.Sound</a> | <a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a> | null</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The Sound to be played when this Buttons Up state is activated.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Sound.html">Phaser.Sound</a></span>
|

<span class="param-type"><a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a></span>
|

<span class="param-type">null</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L112" title="onUpSound on line 112 of src/gameobjects/Button.js">src/gameobjects/Button.js line 112</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="onUpSoundMarker" data-name="onUpSoundMarker">
      <span class="type-signature">&lt;readonly> </span>onUpSoundMarker<span class="type-signature"> : string</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The Sound Marker used in conjunction with the onUpSound.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">string</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L140" title="onUpSoundMarker on line 140 of src/gameobjects/Button.js">src/gameobjects/Button.js line 140</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="parent" data-name="parent">
      <span class="type-signature">&lt;readonly> </span>parent<span class="type-signature"> : <a href="PIXI.DisplayObjectContainer.html">PIXI.DisplayObjectContainer</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The parent DisplayObjectContainer that this DisplayObject is a child of.
All DisplayObjects must belong to a parent in order to be rendered.
The root parent is the Stage object. This property is set automatically when the
DisplayObject is added to, or removed from, a DisplayObjectContainer.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="PIXI.DisplayObjectContainer.html">PIXI.DisplayObjectContainer</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#parent">PIXI.DisplayObject#parent</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L120" title="parent on line 120 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 120</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="pendingDestroy" data-name="pendingDestroy">
      <span class="type-signature"></span>pendingDestroy<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>A Game Object is that is pendingDestroy is flagged to have its destroy method called on the next logic update.
You can set it directly to allow you to flag an object to be destroyed on its next update.</p>
<p>This is extremely useful if you wish to destroy an object from within one of its own callbacks
such as with Buttons or other Input events.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Core.html#pendingDestroy">Phaser.Component.Core#pendingDestroy</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Core.js#L252" title="pendingDestroy on line 252 of src/gameobjects/components/Core.js">src/gameobjects/components/Core.js line 252</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="physicsType" data-name="physicsType">
      <span class="type-signature">&lt;readonly> </span>physicsType<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The const physics body type of this object.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L56" title="physicsType on line 56 of src/gameobjects/Button.js">src/gameobjects/Button.js line 56</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="pivot" data-name="pivot">
      <span class="type-signature"></span>pivot<span class="type-signature"> : PIXI.Point</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The pivot point of this DisplayObject that it rotates around. The values are expressed
in pixel values.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">PIXI.Point</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#pivot">PIXI.DisplayObject#pivot</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L49" title="pivot on line 49 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 49</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="position" data-name="position">
      <span class="type-signature"></span>position<span class="type-signature"> : PIXI.Point</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The coordinates, in pixels, of this DisplayObject, relative to its parent container.</p>
<p>The value of this property does not reflect any positioning happening further up the display list.
To obtain that value please see the <code>worldPosition</code> property.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">PIXI.Point</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#position">PIXI.DisplayObject#position</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L29" title="position on line 29 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 29</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="previousPosition" data-name="previousPosition">
      <span class="type-signature">&lt;readonly> </span>previousPosition<span class="type-signature"> : <a href="Phaser.Point.html">Phaser.Point</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The position the Game Object was located in the previous frame.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Core.html#previousPosition">Phaser.Component.Core#previousPosition</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Core.js#L218" title="previousPosition on line 218 of src/gameobjects/components/Core.js">src/gameobjects/components/Core.js line 218</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="previousRotation" data-name="previousRotation">
      <span class="type-signature">&lt;readonly> </span>previousRotation<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The rotation the Game Object was in set to in the previous frame. Value is in radians.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Core.html#previousRotation">Phaser.Component.Core#previousRotation</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Core.js#L225" title="previousRotation on line 225 of src/gameobjects/components/Core.js">src/gameobjects/components/Core.js line 225</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="renderable" data-name="renderable">
      <span class="type-signature"></span>renderable<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Should this DisplayObject be rendered by the renderer? An object with a renderable value of
<code>false</code> is skipped during the render pass.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#renderable">PIXI.DisplayObject#renderable</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L108" title="renderable on line 108 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 108</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="renderOrderID" data-name="renderOrderID">
      <span class="type-signature">&lt;readonly> </span>renderOrderID<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The render order ID is used internally by the renderer and Input Manager and should not be modified.
This property is mostly used internally by the renderers, but is exposed for the use of plugins.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Core.html#renderOrderID">Phaser.Component.Core#renderOrderID</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Core.js#L233" title="renderOrderID on line 233 of src/gameobjects/components/Core.js">src/gameobjects/components/Core.js line 233</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="right" data-name="right">
      <span class="type-signature"></span>right<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The right coordinate of the Game Object.
This is the same as <code>x + width - offsetX</code>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Bounds.html#right">Phaser.Component.Bounds#right</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Bounds.js#L116" title="right on line 116 of src/gameobjects/components/Bounds.js">src/gameobjects/components/Bounds.js line 116</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="rotation" data-name="rotation">
      <span class="type-signature"></span>rotation<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The rotation of this DisplayObject. The value is given, and expressed, in radians, and is based on
a right-handed orientation.</p>
<p>The value of this property does not reflect any rotation happening further up the display list.
To obtain that value please see the <code>worldRotation</code> property.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#rotation">PIXI.DisplayObject#rotation</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L61" title="rotation on line 61 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 61</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="scale" data-name="scale">
      <span class="type-signature"></span>scale<span class="type-signature"> : PIXI.Point</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The scale of this DisplayObject. A scale of 1:1 represents the DisplayObject
at its default size. A value of 0.5 would scale this DisplayObject by half, and so on.</p>
<p>The value of this property does not reflect any scaling happening further up the display list.
To obtain that value please see the <code>worldScale</code> property.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">PIXI.Point</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#scale">PIXI.DisplayObject#scale</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L41" title="scale on line 41 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 41</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="scaleMax" data-name="scaleMax">
      <span class="type-signature"></span>scaleMax<span class="type-signature"> : <a href="Phaser.Point.html">Phaser.Point</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The maximum scale this Game Object will scale up to.</p>
<p>It allows you to prevent a parent from scaling this Game Object higher than the given value.</p>
<p>Set it to <code>null</code> to remove the limit.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.ScaleMinMax.html#scaleMax">Phaser.Component.ScaleMinMax#scaleMax</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/ScaleMinMax.js#L46" title="scaleMax on line 46 of src/gameobjects/components/ScaleMinMax.js">src/gameobjects/components/ScaleMinMax.js line 46</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="scaleMin" data-name="scaleMin">
      <span class="type-signature"></span>scaleMin<span class="type-signature"> : <a href="Phaser.Point.html">Phaser.Point</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The minimum scale this Game Object will scale down to.</p>
<p>It allows you to prevent a parent from scaling this Game Object lower than the given value.</p>
<p>Set it to <code>null</code> to remove the limit.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.ScaleMinMax.html#scaleMin">Phaser.Component.ScaleMinMax#scaleMin</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/ScaleMinMax.js#L36" title="scaleMin on line 36 of src/gameobjects/components/ScaleMinMax.js">src/gameobjects/components/ScaleMinMax.js line 36</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="shader" data-name="shader">
      <span class="type-signature"></span>shader<span class="type-signature"> : <a href="Phaser.Filter.html">Phaser.Filter</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The shader that will be used to render this Sprite.
Set to null to remove a current shader.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Filter.html">Phaser.Filter</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.Sprite.html#shader">PIXI.Sprite#shader</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>null</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/Sprite.js#L103" title="shader on line 103 of src/pixi/display/Sprite.js">src/pixi/display/Sprite.js line 103</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="smoothed" data-name="smoothed">
      <span class="type-signature"></span>smoothed<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Enable or disable texture smoothing for this Game Object.</p>
<p>It only takes effect if the Game Object is using an image based texture.</p>
<p>Smoothing is enabled by default.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Smoothed.html#smoothed">Phaser.Component.Smoothed#smoothed</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Smoothed.js#L25" title="smoothed on line 25 of src/gameobjects/components/Smoothed.js">src/gameobjects/components/Smoothed.js line 25</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="texture" data-name="texture">
      <span class="type-signature"></span>texture<span class="type-signature"> : Texture</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The texture that the sprite is using</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">Texture</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.Sprite.html#texture">PIXI.Sprite#texture</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/Sprite.js#L36" title="texture on line 36 of src/pixi/display/Sprite.js">src/pixi/display/Sprite.js line 36</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="tint" data-name="tint">
      <span class="type-signature"></span>tint<span class="type-signature"> : Number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF (Phaser.Color.WHITE) will remove any tint effect.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">Number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.Sprite.html#tint">PIXI.Sprite#tint</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>0xFFFFFF</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/Sprite.js#L63" title="tint on line 63 of src/pixi/display/Sprite.js">src/pixi/display/Sprite.js line 63</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="tintedTexture" data-name="tintedTexture">
      <span class="type-signature"></span>tintedTexture<span class="type-signature"> : Canvas</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>A canvas that contains the tinted version of the Sprite (in Canvas mode, WebGL doesn't populate this)</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">Canvas</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.Sprite.html#tintedTexture">PIXI.Sprite#tintedTexture</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>null</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/Sprite.js#L82" title="tintedTexture on line 82 of src/pixi/display/Sprite.js">src/pixi/display/Sprite.js line 82</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="top" data-name="top">
      <span class="type-signature"></span>top<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The y coordinate of the Game Object.
This is the same as <code>y - offsetY</code>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Bounds.html#top">Phaser.Component.Bounds#top</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Bounds.js#L136" title="top on line 136 of src/gameobjects/components/Bounds.js">src/gameobjects/components/Bounds.js line 136</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="transformCallback" data-name="transformCallback">
      <span class="type-signature"></span>transformCallback<span class="type-signature"> : function</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The callback that will apply any scale limiting to the worldTransform.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">function</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.ScaleMinMax.html#transformCallback">Phaser.Component.ScaleMinMax#transformCallback</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/ScaleMinMax.js#L20" title="transformCallback on line 20 of src/gameobjects/components/ScaleMinMax.js">src/gameobjects/components/ScaleMinMax.js line 20</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="transformCallbackContext" data-name="transformCallbackContext">
      <span class="type-signature"></span>transformCallbackContext<span class="type-signature"> : object</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The context under which <code>transformCallback</code> is called.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">object</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.ScaleMinMax.html#transformCallbackContext">Phaser.Component.ScaleMinMax#transformCallbackContext</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/ScaleMinMax.js#L26" title="transformCallbackContext on line 26 of src/gameobjects/components/ScaleMinMax.js">src/gameobjects/components/ScaleMinMax.js line 26</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="type" data-name="type">
      <span class="type-signature">&lt;readonly> </span>type<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The Phaser Object Type.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="Phaser.Image.html#type">Phaser.Image#type</a>
    </li></ul></dd>
    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L50" title="type on line 50 of src/gameobjects/Button.js">src/gameobjects/Button.js line 50</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="visible" data-name="visible">
      <span class="type-signature"></span>visible<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The visibility of this DisplayObject. A value of <code>false</code> makes the object invisible.
A value of <code>true</code> makes it visible.</p>
<p>An object with a visible value of <code>false</code> is skipped during the render pass.
Equally a DisplayObject with visible <code>false</code> will not render any of its children.</p>
<p>The value of this property does not reflect any visible values set further up the display list.
To obtain that value please see the <a href="PIXI.DisplayObject.html#worldVisible">worldVisible</a> property.</p>
<p>Objects that are not <a href="PIXI.DisplayObject.html#worldVisible">worldVisible</a> do not update their <a href="PIXI.DisplayObject.html#worldPosition">worldPosition</a>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#visible">PIXI.DisplayObject#visible</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>true</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L90" title="visible on line 90 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 90</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="width" data-name="width">
      <span class="type-signature"></span>width<span class="type-signature"> : Number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">Number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObjectContainer.html#width">PIXI.DisplayObjectContainer#width</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObjectContainer.js#L576" title="width on line 576 of src/pixi/display/DisplayObjectContainer.js">src/pixi/display/DisplayObjectContainer.js line 576</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="world" data-name="world">
      <span class="type-signature"></span>world<span class="type-signature"> : <a href="Phaser.Point.html">Phaser.Point</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The world coordinates of this Game Object in pixels.
Depending on where in the display list this Game Object is placed this value can differ from <code>position</code>,
which contains the x/y coordinates relative to the Game Objects parent.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Core.html#world">Phaser.Component.Core#world</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Core.js#L204" title="world on line 204 of src/gameobjects/components/Core.js">src/gameobjects/components/Core.js line 204</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="worldAlpha" data-name="worldAlpha">
      <span class="type-signature">&lt;readonly> </span>worldAlpha<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The multiplied alpha value of this DisplayObject. A value of 1 is fully opaque. A value of 0 is transparent.
This value is the calculated total, based on the alpha values of all parents of this DisplayObjects
in the display list.</p>
<p>To obtain, and set, the local alpha value, see the <code>alpha</code> property.</p>
<p>Note: This property is only updated at the end of the <code>updateTransform</code> call, once per render. Until
that happens this property will contain values based on the previous frame. Be mindful of this if
accessing this property outside of the normal game flow, i.e. from an asynchronous event callback.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#worldAlpha">PIXI.DisplayObject#worldAlpha</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L136" title="worldAlpha on line 136 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 136</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="worldPosition" data-name="worldPosition">
      <span class="type-signature">&lt;readonly> </span>worldPosition<span class="type-signature"> : PIXI.Point</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The coordinates, in pixels, of this DisplayObject within the world.</p>
<p>This property contains the calculated total, based on the positions of all parents of this
DisplayObject in the display list.</p>
<p>Note: This property is only updated at the end of the <code>updateTransform</code> call, once per render. Until
that happens this property will contain values based on the previous frame. Be mindful of this if
accessing this property outside of the normal game flow, i.e. from an asynchronous event callback.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">PIXI.Point</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#worldPosition">PIXI.DisplayObject#worldPosition</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L166" title="worldPosition on line 166 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 166</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="worldRotation" data-name="worldRotation">
      <span class="type-signature">&lt;readonly> </span>worldRotation<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The rotation, in radians, of this DisplayObject.</p>
<p>This property contains the calculated total, based on the rotations of all parents of this
DisplayObject in the display list.</p>
<p>Note: This property is only updated at the end of the <code>updateTransform</code> call, once per render. Until
that happens this property will contain values based on the previous frame. Be mindful of this if
accessing this property outside of the normal game flow, i.e. from an asynchronous event callback.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#worldRotation">PIXI.DisplayObject#worldRotation</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L196" title="worldRotation on line 196 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 196</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="worldScale" data-name="worldScale">
      <span class="type-signature">&lt;readonly> </span>worldScale<span class="type-signature"> : PIXI.Point</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The global scale of this DisplayObject.</p>
<p>This property contains the calculated total, based on the scales of all parents of this
DisplayObject in the display list.</p>
<p>Note: This property is only updated at the end of the <code>updateTransform</code> call, once per render. Until
that happens this property will contain values based on the previous frame. Be mindful of this if
accessing this property outside of the normal game flow, i.e. from an asynchronous event callback.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">PIXI.Point</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#worldScale">PIXI.DisplayObject#worldScale</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L181" title="worldScale on line 181 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 181</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="worldTransform" data-name="worldTransform">
      <span class="type-signature">&lt;readonly> </span>worldTransform<span class="type-signature"> : <a href="Phaser.Matrix.html">Phaser.Matrix</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The current transform of this DisplayObject.</p>
<p>This property contains the calculated total, based on the transforms of all parents of this
DisplayObject in the display list.</p>
<p>Note: This property is only updated at the end of the <code>updateTransform</code> call, once per render. Until
that happens this property will contain values based on the previous frame. Be mindful of this if
accessing this property outside of the normal game flow, i.e. from an asynchronous event callback.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Matrix.html">Phaser.Matrix</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#worldTransform">PIXI.DisplayObject#worldTransform</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L151" title="worldTransform on line 151 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 151</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="worldVisible" data-name="worldVisible">
      <span class="type-signature"></span>worldVisible<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Indicates if this DisplayObject is visible, based on it, and all of its parents, <code>visible</code> property values.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#worldVisible">PIXI.DisplayObject#worldVisible</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L666" title="worldVisible on line 666 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 666</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="x" data-name="x">
      <span class="type-signature"></span>x<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The horizontal position of the DisplayObject, in pixels, relative to its parent.
If you need the world position of the DisplayObject, use <code>DisplayObject.worldPosition</code> instead.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#x">PIXI.DisplayObject#x</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L626" title="x on line 626 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 626</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="y" data-name="y">
      <span class="type-signature"></span>y<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The vertical position of the DisplayObject, in pixels, relative to its parent.
If you need the world position of the DisplayObject, use <code>DisplayObject.worldPosition</code> instead.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#y">PIXI.DisplayObject#y</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L646" title="y on line 646 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 646</a>
    

	

	

	
</dl>


    
</dd>

        
            
<dt>
    <h4 id="z" data-name="z">
      <span class="type-signature">&lt;readonly> </span>z<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The z depth of this Game Object within its parent Group.
No two objects in a Group can have the same z value.
This value is adjusted automatically whenever the Group hierarchy changes.
If you wish to re-order the layering of a Game Object then see methods like Group.moveUp or Group.bringToTop.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Core.html#z">Phaser.Component.Core#z</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Core.js#L170" title="z on line 170 of src/gameobjects/components/Core.js">src/gameobjects/components/Core.js line 170</a>
    

	

	

	
</dl>


    
</dd>

        </dl>
    

    
        <h3 class="subsection-title">Methods</h3>

        <dl>
            
<dt>
    <h4 class="name" id="addChild" data-name="addChild">
      <span class="type-signature"></span>addChild(child)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Adds a child to the container.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>child</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#DisplayObject">DisplayObject</a></span>



            
            </td>

            

            

            <td class="description param-description last"><p>The DisplayObject to add to the container</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObjectContainer.html#addChild">PIXI.DisplayObjectContainer#addChild</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObjectContainer.js#L41" title="addChild on line 41 of src/pixi/display/DisplayObjectContainer.js">src/pixi/display/DisplayObjectContainer.js line 41</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>The child that was added.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="global.html#DisplayObject">DisplayObject</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="addChildAt" data-name="addChildAt">
      <span class="type-signature"></span>addChildAt(child, index)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>child</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#DisplayObject">DisplayObject</a></span>



            
            </td>

            

            

            <td class="description param-description last"><p>The child to add</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>index</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            

            

            <td class="description param-description last"><p>The index to place the child in</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObjectContainer.html#addChildAt">PIXI.DisplayObjectContainer#addChildAt</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObjectContainer.js#L53" title="addChildAt on line 53 of src/pixi/display/DisplayObjectContainer.js">src/pixi/display/DisplayObjectContainer.js line 53</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>The child that was added.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="global.html#DisplayObject">DisplayObject</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="alignIn" data-name="alignIn">
      <span class="type-signature"></span>alignIn(container [, position] [, offsetX] [, offsetY])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Aligns this Game Object within another Game Object, or Rectangle, known as the
'container', to one of 9 possible positions.</p>
<p>The container must be a Game Object, or Phaser.Rectangle object. This can include properties
such as <code>World.bounds</code> or <code>Camera.view</code>, for aligning Game Objects within the world
and camera bounds. Or it can include other Sprites, Images, Text objects, BitmapText,
TileSprites or Buttons.</p>
<p>Please note that aligning a Sprite to another Game Object does <strong>not</strong> make it a child of
the container. It simply modifies its position coordinates so it aligns with it.</p>
<p>The position constants you can use are:</p>
<p><code>Phaser.TOP_LEFT</code>, <code>Phaser.TOP_CENTER</code>, <code>Phaser.TOP_RIGHT</code>, <code>Phaser.LEFT_CENTER</code>,
<code>Phaser.CENTER</code>, <code>Phaser.RIGHT_CENTER</code>, <code>Phaser.BOTTOM_LEFT</code>,
<code>Phaser.BOTTOM_CENTER</code> and <code>Phaser.BOTTOM_RIGHT</code>.</p>
<p>The Game Objects are placed in such a way that their <em>bounds</em> align with the
container, taking into consideration rotation, scale and the anchor property.
This allows you to neatly align Game Objects, irrespective of their position value.</p>
<p>The optional <code>offsetX</code> and <code>offsetY</code> arguments allow you to apply extra spacing to the final
aligned position of the Game Object. For example:</p>
<p><code>sprite.alignIn(background, Phaser.BOTTOM_RIGHT, -20, -20)</code></p>
<p>Would align the <code>sprite</code> to the bottom-right, but moved 20 pixels in from the corner.
Think of the offsets as applying an adjustment to the containers bounds before the alignment takes place.
So providing a negative offset will 'shrink' the container bounds by that amount, and providing a positive
one expands it.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>container</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>
|

<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
|

<span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span>
|

<span class="param-type"><a href="Phaser.Text.html">Phaser.Text</a></span>
|

<span class="param-type"><a href="Phaser.BitmapText.html">Phaser.BitmapText</a></span>
|

<span class="param-type"><a href="Phaser.Button.html">Phaser.Button</a></span>
|

<span class="param-type"><a href="Phaser.Graphics.html">Phaser.Graphics</a></span>
|

<span class="param-type"><a href="Phaser.TileSprite.html">Phaser.TileSprite</a></span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>The Game Object or Rectangle with which to align this Game Object to. Can also include properties such as <code>World.bounds</code> or <code>Camera.view</code>.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>position</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>The position constant. One of <code>Phaser.TOP_LEFT</code> (default), <code>Phaser.TOP_CENTER</code>, <code>Phaser.TOP_RIGHT</code>, <code>Phaser.LEFT_CENTER</code>, <code>Phaser.CENTER</code>, <code>Phaser.RIGHT_CENTER</code>, <code>Phaser.BOTTOM_LEFT</code>, <code>Phaser.BOTTOM_CENTER</code> or <code>Phaser.BOTTOM_RIGHT</code>.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>offsetX</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description param-description last"><p>A horizontal adjustment of the Containers bounds, applied to the aligned position of the Game Object. Use a negative value to shrink the bounds, positive to increase it.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>offsetY</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description param-description last"><p>A vertical adjustment of the Containers bounds, applied to the aligned position of the Game Object. Use a negative value to shrink the bounds, positive to increase it.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Bounds.html#alignIn">Phaser.Component.Bounds#alignIn</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Bounds.js#L209" title="alignIn on line 209 of src/gameobjects/components/Bounds.js">src/gameobjects/components/Bounds.js line 209</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Game Object.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="alignTo" data-name="alignTo">
      <span class="type-signature"></span>alignTo(parent [, position] [, offsetX] [, offsetY])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Aligns this Game Object to the side of another Game Object, or Rectangle, known as the
'parent', in one of 11 possible positions.</p>
<p>The parent must be a Game Object, or Phaser.Rectangle object. This can include properties
such as <code>World.bounds</code> or <code>Camera.view</code>, for aligning Game Objects within the world
and camera bounds. Or it can include other Sprites, Images, Text objects, BitmapText,
TileSprites or Buttons.</p>
<p>Please note that aligning a Sprite to another Game Object does <strong>not</strong> make it a child of
the parent. It simply modifies its position coordinates so it aligns with it.</p>
<p>The position constants you can use are:</p>
<p><code>Phaser.TOP_LEFT</code> (default), <code>Phaser.TOP_CENTER</code>, <code>Phaser.TOP_RIGHT</code>, <code>Phaser.LEFT_TOP</code>,
<code>Phaser.LEFT_CENTER</code>, <code>Phaser.LEFT_BOTTOM</code>, <code>Phaser.RIGHT_TOP</code>, <code>Phaser.RIGHT_CENTER</code>,
<code>Phaser.RIGHT_BOTTOM</code>, <code>Phaser.BOTTOM_LEFT</code>, <code>Phaser.BOTTOM_CENTER</code>
and <code>Phaser.BOTTOM_RIGHT</code>.</p>
<p>The Game Objects are placed in such a way that their <em>bounds</em> align with the
parent, taking into consideration rotation, scale and the anchor property.
This allows you to neatly align Game Objects, irrespective of their position value.</p>
<p>The optional <code>offsetX</code> and <code>offsetY</code> arguments allow you to apply extra spacing to the final
aligned position of the Game Object. For example:</p>
<p><code>sprite.alignTo(background, Phaser.BOTTOM_RIGHT, -20, -20)</code></p>
<p>Would align the <code>sprite</code> to the bottom-right, but moved 20 pixels in from the corner.
Think of the offsets as applying an adjustment to the parents bounds before the alignment takes place.
So providing a negative offset will 'shrink' the parent bounds by that amount, and providing a positive
one expands it.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>parent</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>
|

<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
|

<span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span>
|

<span class="param-type"><a href="Phaser.Text.html">Phaser.Text</a></span>
|

<span class="param-type"><a href="Phaser.BitmapText.html">Phaser.BitmapText</a></span>
|

<span class="param-type"><a href="Phaser.Button.html">Phaser.Button</a></span>
|

<span class="param-type"><a href="Phaser.Graphics.html">Phaser.Graphics</a></span>
|

<span class="param-type"><a href="Phaser.TileSprite.html">Phaser.TileSprite</a></span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>The Game Object or Rectangle with which to align this Game Object to. Can also include properties such as <code>World.bounds</code> or <code>Camera.view</code>.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>position</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>The position constant. One of <code>Phaser.TOP_LEFT</code>, <code>Phaser.TOP_CENTER</code>, <code>Phaser.TOP_RIGHT</code>, <code>Phaser.LEFT_TOP</code>, <code>Phaser.LEFT_CENTER</code>, <code>Phaser.LEFT_BOTTOM</code>, <code>Phaser.RIGHT_TOP</code>, <code>Phaser.RIGHT_CENTER</code>, <code>Phaser.RIGHT_BOTTOM</code>, <code>Phaser.BOTTOM_LEFT</code>, <code>Phaser.BOTTOM_CENTER</code> or <code>Phaser.BOTTOM_RIGHT</code>.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>offsetX</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description param-description last"><p>A horizontal adjustment of the Containers bounds, applied to the aligned position of the Game Object. Use a negative value to shrink the bounds, positive to increase it.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>offsetY</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description param-description last"><p>A vertical adjustment of the Containers bounds, applied to the aligned position of the Game Object. Use a negative value to shrink the bounds, positive to increase it.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Bounds.html#alignTo">Phaser.Component.Bounds#alignTo</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Bounds.js#L306" title="alignTo on line 306 of src/gameobjects/components/Bounds.js">src/gameobjects/components/Bounds.js line 306</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Game Object.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="bringToTop" data-name="bringToTop">
      <span class="type-signature"></span>bringToTop()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Brings this Game Object to the top of its parent's display list (the last position).
Visually this means it will render over the top of all other children of the same parent.</p>
<p>If this Game Object hasn't been added to a custom Group then this method will bring it to the top of the Game World,
because the World is the root Group from which all Game Objects descend.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.BringToTop.html#bringToTop">Phaser.Component.BringToTop#bringToTop</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/BringToTop.js#L24" title="bringToTop on line 24 of src/gameobjects/components/BringToTop.js">src/gameobjects/components/BringToTop.js line 24</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="clearFrames" data-name="clearFrames">
      <span class="type-signature"></span>clearFrames()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Clears all of the frames set on this Button.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L234" title="clearFrames on line 234 of src/gameobjects/Button.js">src/gameobjects/Button.js line 234</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="contains" data-name="contains">
      <span class="type-signature"></span>contains(child)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>child</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#DisplayObject">DisplayObject</a></span>



            
            </td>

            

            

            <td class="description param-description last"></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObjectContainer.html#contains">PIXI.DisplayObjectContainer#contains</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObjectContainer.js#L456" title="contains on line 456 of src/pixi/display/DisplayObjectContainer.js">src/pixi/display/DisplayObjectContainer.js line 456</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="crop" data-name="crop">
      <span class="type-signature"></span>crop(rect [, copy])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Crop allows you to crop the texture being used to display this Game Object.
Setting a crop rectangle modifies the core texture frame. The Game Object width and height properties will be adjusted accordingly.</p>
<p>Cropping takes place from the top-left and can be modified in real-time either by providing an updated rectangle object to this method,
or by modifying <code>cropRect</code> property directly and then calling <code>updateCrop</code>.</p>
<p>The rectangle object given to this method can be either a <code>Phaser.Rectangle</code> or any other object
so long as it has public <code>x</code>, <code>y</code>, <code>width</code>, <code>height</code>, <code>right</code> and <code>bottom</code> properties.</p>
<p>A reference to the rectangle is stored in <code>cropRect</code> unless the <code>copy</code> parameter is <code>true</code>,
in which case the values are duplicated to a local object.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>rect</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>The Rectangle used during cropping. Pass null or no parameters to clear a previously set crop rectangle.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>copy</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description param-description last"><p>If false <code>cropRect</code> will be stored as a reference to the given rect. If true it will copy the rect values into a local Phaser Rectangle object stored in cropRect.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Crop.html#crop">Phaser.Component.Crop#crop</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Crop.js#L49" title="crop on line 49 of src/gameobjects/components/Crop.js">src/gameobjects/components/Crop.js line 49</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="destroy" data-name="destroy">
      <span class="type-signature"></span>destroy()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Destroy this DisplayObject.</p>
<p>Removes any cached sprites, sets renderable flag to false, and nulls filters, bounds and mask.</p>
<p>Also iteratively calls <code>destroy</code> on any children.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#destroy">PIXI.DisplayObject#destroy</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L254" title="destroy on line 254 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 254</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="generateTexture" data-name="generateTexture">
      <span class="type-signature"></span>generateTexture( [resolution] [, scaleMode], renderer)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Generates a RenderTexture based on this DisplayObject, which can they be used to texture other Sprites.
This can be useful if your DisplayObject is static, or complicated, and needs to be reused multiple times.</p>
<p>Please note that no garbage collection takes place on old textures. It is up to you to destroy old textures,
and references to them, so they don't linger in memory.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>resolution</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    1
                
                </td>
            

            <td class="description param-description last"><p>The resolution of the texture being generated.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>scaleMode</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    PIXI.scaleModes.DEFAULT
                
                </td>
            

            <td class="description param-description last"><p>See {{#crossLink &quot;PIXI/scaleModes:property&quot;}}PIXI.scaleModes{{/crossLink}} for possible values.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>renderer</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="PIXI.CanvasRenderer.html">PIXI.CanvasRenderer</a></span>
|

<span class="param-type"><a href="PIXI.WebGLRenderer.html">PIXI.WebGLRenderer</a></span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>The renderer used to generate the texture.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#generateTexture">PIXI.DisplayObject#generateTexture</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L443" title="generateTexture on line 443 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 443</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <ul>
<li>A RenderTexture containing an image of this DisplayObject at the time it was invoked.</li>
</ul>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.RenderTexture.html">Phaser.RenderTexture</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="getBounds" data-name="getBounds">
      <span class="type-signature"></span>getBounds(matrix)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Returns the bounds of the Sprite as a rectangle.
The bounds calculation takes the worldTransform into account.</p>
<p>The worldTransform was calculated during the last render pass and is not updated when you call this method.
If this Sprite was just created and has never been rendered, you can call <code>updateTransform</code> on the Sprite itself.
If any of the Sprite's ancestors have been positioned, scaled, or rotated since the last render pass,
those changes have not yet have been applied to this Sprite's worldTransform. Call <code>updateTransform</code>
on the root-most (highest) ancestor that was changed.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>matrix</code></td>
            

            <td class="type">
            
                
<span class="param-type">Matrix</span>



            
            </td>

            

            

            <td class="description param-description last"><p>the transformation matrix of the sprite</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.Sprite.html#getBounds">PIXI.Sprite#getBounds</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/Sprite.js#L211" title="getBounds on line 211 of src/pixi/display/Sprite.js">src/pixi/display/Sprite.js line 211</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>the framing rectangle</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Rectangle</span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="getChildAt" data-name="getChildAt">
      <span class="type-signature"></span>getChildAt(index)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Returns the child at the specified index</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>index</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            

            

            <td class="description param-description last"><p>The index to get the child from</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObjectContainer.html#getChildAt">PIXI.DisplayObjectContainer#getChildAt</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObjectContainer.js#L147" title="getChildAt on line 147 of src/pixi/display/DisplayObjectContainer.js">src/pixi/display/DisplayObjectContainer.js line 147</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>The child at the given index, if any.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="global.html#DisplayObject">DisplayObject</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="getChildIndex" data-name="getChildIndex">
      <span class="type-signature"></span>getChildIndex(child)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Returns the index position of a child DisplayObject instance</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>child</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#DisplayObject">DisplayObject</a></span>



            
            </td>

            

            

            <td class="description param-description last"><p>The DisplayObject instance to identify</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObjectContainer.html#getChildIndex">PIXI.DisplayObjectContainer#getChildIndex</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObjectContainer.js#L108" title="getChildIndex on line 108 of src/pixi/display/DisplayObjectContainer.js">src/pixi/display/DisplayObjectContainer.js line 108</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>The index position of the child display object to identify</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Number</span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="getLocalBounds" data-name="getLocalBounds">
      <span class="type-signature"></span>getLocalBounds()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Retrieves the non-global local bounds of the Sprite as a rectangle. The calculation takes all visible children into consideration.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.Sprite.html#getLocalBounds">PIXI.Sprite#getLocalBounds</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/Sprite.js#L328" title="getLocalBounds on line 328 of src/pixi/display/Sprite.js">src/pixi/display/Sprite.js line 328</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>The rectangular bounding area</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Rectangle</span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="kill" data-name="kill">
      <span class="type-signature"></span>kill()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Kills a Game Object. A killed Game Object has its <code>alive</code>, <code>exists</code> and <code>visible</code> properties all set to false.</p>
<p>It will dispatch the <code>onKilled</code> event. You can listen to <code>events.onKilled</code> for the signal.</p>
<p>Note that killing a Game Object is a way for you to quickly recycle it in an object pool,
it doesn't destroy the object or free it up from memory.</p>
<p>If you don't need this Game Object any more you should call <code>destroy</code> instead.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.LifeSpan.html#kill">Phaser.Component.LifeSpan#kill</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/LifeSpan.js#L117" title="kill on line 117 of src/gameobjects/components/LifeSpan.js">src/gameobjects/components/LifeSpan.js line 117</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="loadTexture" data-name="loadTexture">
      <span class="type-signature"></span>loadTexture(key [, frame] [, stopAnimation])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Changes the base texture the Game Object is using. The old texture is removed and the new one is referenced or fetched from the Cache.</p>
<p>If your Game Object is using a frame from a texture atlas and you just wish to change to another frame, then see the <code>frame</code> or <code>frameName</code> properties instead.</p>
<p>You should only use <code>loadTexture</code> if you want to replace the base texture entirely.</p>
<p>Calling this method causes a WebGL texture update, so use sparingly or in low-intensity portions of your game, or if you know the new texture is already on the GPU.</p>
<p>You can use the new const <code>Phaser.PENDING_ATLAS</code> as the texture key for any sprite.
Doing this then sets the key to be the <code>frame</code> argument (the frame is set to zero).</p>
<p>This allows you to create sprites using <code>load.image</code> during development, and then change them
to use a Texture Atlas later in development by simply searching your code for 'PENDING_ATLAS'
and swapping it to be the key of the atlas data.</p>
<p>Note: You cannot use a RenderTexture as a texture for a TileSprite.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>key</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type"><a href="Phaser.RenderTexture.html">Phaser.RenderTexture</a></span>
|

<span class="param-type"><a href="Phaser.BitmapData.html">Phaser.BitmapData</a></span>
|

<span class="param-type"><a href="Phaser.Video.html">Phaser.Video</a></span>
|

<span class="param-type"><a href="PIXI.Texture.html">PIXI.Texture</a></span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache Image entry, or an instance of a RenderTexture, BitmapData, Video or PIXI.Texture.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>frame</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>If this Sprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>stopAnimation</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description param-description last"><p>If an animation is already playing on this Sprite you can choose to stop it or let it carry on playing.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.LoadTexture.html#loadTexture">Phaser.Component.LoadTexture#loadTexture</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/LoadTexture.js#L51" title="loadTexture on line 51 of src/gameobjects/components/LoadTexture.js">src/gameobjects/components/LoadTexture.js line 51</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="moveDown" data-name="moveDown">
      <span class="type-signature"></span>moveDown()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Moves this Game Object down one place in its parents display list.
This call has no effect if the Game Object is already at the bottom of the display list.</p>
<p>If this Game Object hasn't been added to a custom Group then this method will move it one object down within the Game World,
because the World is the root Group from which all Game Objects descend.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.BringToTop.html#moveDown">Phaser.Component.BringToTop#moveDown</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/BringToTop.js#L84" title="moveDown on line 84 of src/gameobjects/components/BringToTop.js">src/gameobjects/components/BringToTop.js line 84</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="moveUp" data-name="moveUp">
      <span class="type-signature"></span>moveUp()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Moves this Game Object up one place in its parent's display list.
This call has no effect if the Game Object is already at the top of the display list.</p>
<p>If this Game Object hasn't been added to a custom Group then this method will move it one object up within the Game World,
because the World is the root Group from which all Game Objects descend.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.BringToTop.html#moveUp">Phaser.Component.BringToTop#moveUp</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/BringToTop.js#L64" title="moveUp on line 64 of src/gameobjects/components/BringToTop.js">src/gameobjects/components/BringToTop.js line 64</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="onInputDownHandler" data-name="onInputDownHandler">
      <span class="type-signature">&lt;protected> </span>onInputDownHandler(sprite, pointer)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Internal function that handles input events.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sprite</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Button.html">Phaser.Button</a></span>



            
            </td>

            

            

            <td class="description param-description last"><p>The Button that the event occurred on.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>pointer</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>



            
            </td>

            

            

            <td class="description param-description last"><p>The Pointer that activated the Button.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L508" title="onInputDownHandler on line 508 of src/gameobjects/Button.js">src/gameobjects/Button.js line 508</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="onInputOutHandler" data-name="onInputOutHandler">
      <span class="type-signature">&lt;protected> </span>onInputOutHandler(sprite, pointer)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Internal function that handles input events.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sprite</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Button.html">Phaser.Button</a></span>



            
            </td>

            

            

            <td class="description param-description last"><p>The Button that the event occurred on.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>pointer</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>



            
            </td>

            

            

            <td class="description param-description last"><p>The Pointer that activated the Button.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L488" title="onInputOutHandler on line 488 of src/gameobjects/Button.js">src/gameobjects/Button.js line 488</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="onInputOverHandler" data-name="onInputOverHandler">
      <span class="type-signature">&lt;protected> </span>onInputOverHandler(sprite, pointer)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Internal function that handles input events.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sprite</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Button.html">Phaser.Button</a></span>



            
            </td>

            

            

            <td class="description param-description last"><p>The Button that the event occurred on.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>pointer</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>



            
            </td>

            

            

            <td class="description param-description last"><p>The Pointer that activated the Button.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L456" title="onInputOverHandler on line 456 of src/gameobjects/Button.js">src/gameobjects/Button.js line 456</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="onInputUpHandler" data-name="onInputUpHandler">
      <span class="type-signature">&lt;protected> </span>onInputUpHandler(sprite, pointer, isOver)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Internal function that handles input events.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sprite</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Button.html">Phaser.Button</a></span>



            
            </td>

            

            

            <td class="description param-description last"><p>The Button that the event occurred on.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>pointer</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>



            
            </td>

            

            

            <td class="description param-description last"><p>The Pointer that activated the Button.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>isOver</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            

            

            <td class="description param-description last"><p>Is the Pointer still over the Game Object?</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L528" title="onInputUpHandler on line 528 of src/gameobjects/Button.js">src/gameobjects/Button.js line 528</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="overlap" data-name="overlap">
      <span class="type-signature"></span>overlap(displayObject)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Checks to see if the bounds of this Game Object overlaps with the bounds of the given Display Object,
which can be a Sprite, Image, TileSprite or anything that extends those such as Button or provides a <code>getBounds</code> method and result.</p>
<p>This check ignores the <code>hitArea</code> property if set and runs a <code>getBounds</code> comparison on both objects to determine the result.</p>
<p>Therefore it's relatively expensive to use in large quantities, i.e. with lots of Sprites at a high frequency.
It should be fine for low-volume testing where physics isn't required.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>displayObject</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
|

<span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span>
|

<span class="param-type"><a href="Phaser.TileSprite.html">Phaser.TileSprite</a></span>
|

<span class="param-type"><a href="Phaser.Button.html">Phaser.Button</a></span>
|

<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>



            
            </td>

            

            

            <td class="description param-description last"><p>The display object to check against.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Overlap.html#overlap">Phaser.Component.Overlap#overlap</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Overlap.js#L29" title="overlap on line 29 of src/gameobjects/components/Overlap.js">src/gameobjects/components/Overlap.js line 29</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>True if the bounds of this Game Object intersects at any point with the bounds of the given display object.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="play" data-name="play">
      <span class="type-signature"></span>play(name [, frameRate] [, loop] [, killOnComplete])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Plays an Animation.</p>
<p>The animation should have previously been created via <code>animations.add</code>.</p>
<p>If the animation is already playing calling this again won't do anything.
If you need to reset an already running animation do so directly on the Animation object itself or via <code>AnimationManager.stop</code>.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>The name of the animation to be played, e.g. &quot;fire&quot;, &quot;walk&quot;, &quot;jump&quot;. Must have been previously created via 'AnimationManager.add'.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>frameRate</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    null
                
                </td>
            

            <td class="description param-description last"><p>The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>loop</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description param-description last"><p>Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>killOnComplete</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description param-description last"><p>If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Animation.html#play">Phaser.Component.Animation#play</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Animation.js#L31" title="play on line 31 of src/gameobjects/components/Animation.js">src/gameobjects/components/Animation.js line 31</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>A reference to playing Animation.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Animation.html">Phaser.Animation</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="postUpdate" data-name="postUpdate">
      <span class="type-signature">&lt;protected> </span>postUpdate()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Internal method called by the World postUpdate cycle.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Core.html#postUpdate">Phaser.Component.Core#postUpdate</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Core.js#L354" title="postUpdate on line 354 of src/gameobjects/components/Core.js">src/gameobjects/components/Core.js line 354</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="preUpdate" data-name="preUpdate">
      <span class="type-signature"></span>preUpdate()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Automatically called by World.preUpdate.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Image.html#preUpdate">Phaser.Image#preUpdate</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Image.js#L80" title="preUpdate on line 80 of src/gameobjects/Image.js">src/gameobjects/Image.js line 80</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="preUpdateChildren" data-name="preUpdateChildren">
      <span class="type-signature">&lt;protected> </span>preUpdateChildren()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Internal method called by preUpdate.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Core.html#preUpdateChildren">Phaser.Component.Core#preUpdateChildren</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Core.js#L318" title="preUpdateChildren on line 318 of src/gameobjects/components/Core.js">src/gameobjects/components/Core.js line 318</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="removeChild" data-name="removeChild">
      <span class="type-signature"></span>removeChild(child)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Removes a child from the container.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>child</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#DisplayObject">DisplayObject</a></span>



            
            </td>

            

            

            <td class="description param-description last"><p>The DisplayObject to remove</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObjectContainer.html#removeChild">PIXI.DisplayObjectContainer#removeChild</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObjectContainer.js#L164" title="removeChild on line 164 of src/pixi/display/DisplayObjectContainer.js">src/pixi/display/DisplayObjectContainer.js line 164</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>The child that was removed.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="global.html#DisplayObject">DisplayObject</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="removeChildAt" data-name="removeChildAt">
      <span class="type-signature"></span>removeChildAt(index)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Removes a child from the specified index position.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>index</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            

            

            <td class="description param-description last"><p>The index to get the child from</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObjectContainer.html#removeChildAt">PIXI.DisplayObjectContainer#removeChildAt</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObjectContainer.js#L183" title="removeChildAt on line 183 of src/pixi/display/DisplayObjectContainer.js">src/pixi/display/DisplayObjectContainer.js line 183</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>The child that was removed.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="global.html#DisplayObject">DisplayObject</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="removeChildren" data-name="removeChildren">
      <span class="type-signature"></span>removeChildren(beginIndex, endIndex)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Removes all children from this container that are within the begin and end indexes.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>beginIndex</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            

            

            <td class="description param-description last"><p>The beginning position. Default value is 0.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>endIndex</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            

            

            <td class="description param-description last"><p>The ending position. Default value is size of the container.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObjectContainer.html#removeChildren">PIXI.DisplayObjectContainer#removeChildren</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObjectContainer.js#L224" title="removeChildren on line 224 of src/pixi/display/DisplayObjectContainer.js">src/pixi/display/DisplayObjectContainer.js line 224</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="reset" data-name="reset">
      <span class="type-signature"></span>reset(x, y [, health])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Resets the Game Object.</p>
<p>This moves the Game Object to the given x/y world coordinates and sets <code>fresh</code>, <code>exists</code>,
<code>visible</code> and <code>renderable</code> to true.</p>
<p>If this Game Object has the LifeSpan component it will also set <code>alive</code> to true and <code>health</code> to the given value.</p>
<p>If this Game Object has a Physics Body it will reset the Body.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>The x coordinate (in world space) to position the Game Object at.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>The y coordinate (in world space) to position the Game Object at.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>health</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    1
                
                </td>
            

            <td class="description param-description last"><p>The health to give the Game Object if it has the Health component.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Reset.html#reset">Phaser.Component.Reset#reset</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Reset.js#L30" title="reset on line 30 of src/gameobjects/components/Reset.js">src/gameobjects/components/Reset.js line 30</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="resetFrame" data-name="resetFrame">
      <span class="type-signature"></span>resetFrame()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Resets the texture frame dimensions that the Game Object uses for rendering.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.LoadTexture.html#resetFrame">Phaser.Component.LoadTexture#resetFrame</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/LoadTexture.js#L236" title="resetFrame on line 236 of src/gameobjects/components/LoadTexture.js">src/gameobjects/components/LoadTexture.js line 236</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="resizeFrame" data-name="resizeFrame">
      <span class="type-signature"></span>resizeFrame(parent, width, height)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Resizes the Frame dimensions that the Game Object uses for rendering.</p>
<p>You shouldn't normally need to ever call this, but in the case of special texture types such as Video or BitmapData
it can be useful to adjust the dimensions directly in this way.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>parent</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>



            
            </td>

            

            

            <td class="description param-description last"><p>The parent texture object that caused the resize, i.e. a Phaser.Video object.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            

            

            <td class="description param-description last"><p>The new width of the texture.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            

            

            <td class="description param-description last"><p>The new height of the texture.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.LoadTexture.html#resizeFrame">Phaser.Component.LoadTexture#resizeFrame</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/LoadTexture.js#L225" title="resizeFrame on line 225 of src/gameobjects/components/LoadTexture.js">src/gameobjects/components/LoadTexture.js line 225</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="revive" data-name="revive">
      <span class="type-signature"></span>revive( [health])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Brings a 'dead' Game Object back to life, optionally resetting its health value in the process.</p>
<p>A resurrected Game Object has its <code>alive</code>, <code>exists</code> and <code>visible</code> properties all set to true.</p>
<p>It will dispatch the <code>onRevived</code> event. Listen to <code>events.onRevived</code> for the signal.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>health</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    100
                
                </td>
            

            <td class="description param-description last"><p>The health to give the Game Object. Only set if the GameObject has the Health component.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.LifeSpan.html#revive">Phaser.Component.LifeSpan#revive</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/LifeSpan.js#L83" title="revive on line 83 of src/gameobjects/components/LifeSpan.js">src/gameobjects/components/LifeSpan.js line 83</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="sendToBack" data-name="sendToBack">
      <span class="type-signature"></span>sendToBack()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Sends this Game Object to the bottom of its parent's display list (the first position).
Visually this means it will render below all other children of the same parent.</p>
<p>If this Game Object hasn't been added to a custom Group then this method will send it to the bottom of the Game World,
because the World is the root Group from which all Game Objects descend.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.BringToTop.html#sendToBack">Phaser.Component.BringToTop#sendToBack</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/BringToTop.js#L44" title="sendToBack on line 44 of src/gameobjects/components/BringToTop.js">src/gameobjects/components/BringToTop.js line 44</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="setChildIndex" data-name="setChildIndex">
      <span class="type-signature"></span>setChildIndex(child, index)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Changes the position of an existing child in the display object container</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>child</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#DisplayObject">DisplayObject</a></span>



            
            </td>

            

            

            <td class="description param-description last"><p>The child DisplayObject instance for which you want to change the index number</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>index</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            

            

            <td class="description param-description last"><p>The resulting index number for the child display object</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObjectContainer.html#setChildIndex">PIXI.DisplayObjectContainer#setChildIndex</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObjectContainer.js#L127" title="setChildIndex on line 127 of src/pixi/display/DisplayObjectContainer.js">src/pixi/display/DisplayObjectContainer.js line 127</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="setDownSound" data-name="setDownSound">
      <span class="type-signature"></span>setDownSound(sound [, marker])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>The Sound to be played when a Pointer presses down on this Button.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sound</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Sound.html">Phaser.Sound</a></span>
|

<span class="param-type"><a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a></span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>The Sound that will be played.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>marker</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>A Sound Marker that will be used in the playback.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L430" title="setDownSound on line 430 of src/gameobjects/Button.js">src/gameobjects/Button.js line 430</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="setFrame" data-name="setFrame">
      <span class="type-signature"></span>setFrame(frame)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Sets the texture frame the Game Object uses for rendering.</p>
<p>This is primarily an internal method used by <code>loadTexture</code>, but is exposed for the use of plugins and custom classes.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>frame</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Frame.html">Phaser.Frame</a></span>



            
            </td>

            

            

            <td class="description param-description last"><p>The Frame to be used by the texture.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.LoadTexture.html#setFrame">Phaser.Component.LoadTexture#setFrame</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/LoadTexture.js#L156" title="setFrame on line 156 of src/gameobjects/components/LoadTexture.js">src/gameobjects/components/LoadTexture.js line 156</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="setFrames" data-name="setFrames">
      <span class="type-signature"></span>setFrames( [overFrame] [, outFrame] [, downFrame] [, upFrame])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Used to manually set the frames that will be used for the different states of the Button.</p>
<p>Frames can be specified as either an integer (the frame ID) or a string (the frame name); these are the same values that can be used with a Sprite constructor.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>overFrame</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>The frame / frameName when the button is in the Over state.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>outFrame</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>The frame / frameName when the button is in the Out state.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>downFrame</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>The frame / frameName when the button is in the Down state.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>upFrame</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>The frame / frameName when the button is in the Up state.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L306" title="setFrames on line 306 of src/gameobjects/Button.js">src/gameobjects/Button.js line 306</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="setOutSound" data-name="setOutSound">
      <span class="type-signature"></span>setOutSound(sound [, marker])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>The Sound to be played when a Pointer moves out of this Button.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sound</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Sound.html">Phaser.Sound</a></span>
|

<span class="param-type"><a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a></span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>The Sound that will be played.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>marker</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>A Sound Marker that will be used in the playback.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L417" title="setOutSound on line 417 of src/gameobjects/Button.js">src/gameobjects/Button.js line 417</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="setOverSound" data-name="setOverSound">
      <span class="type-signature"></span>setOverSound(sound [, marker])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>The Sound to be played when a Pointer moves over this Button.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sound</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Sound.html">Phaser.Sound</a></span>
|

<span class="param-type"><a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a></span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>The Sound that will be played.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>marker</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>A Sound Marker that will be used in the playback.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L404" title="setOverSound on line 404 of src/gameobjects/Button.js">src/gameobjects/Button.js line 404</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="setScaleMinMax" data-name="setScaleMinMax">
      <span class="type-signature"></span>setScaleMinMax(minX, minY, maxX, maxY)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Sets the scaleMin and scaleMax values. These values are used to limit how far this Game Object will scale based on its parent.</p>
<p>For example if this Game Object has a <code>minScale</code> value of 1 and its parent has a <code>scale</code> value of 0.5, the 0.5 will be ignored
and the scale value of 1 will be used, as the parents scale is lower than the minimum scale this Game Object should adhere to.</p>
<p>By setting these values you can carefully control how Game Objects deal with responsive scaling.</p>
<p>If only one parameter is given then that value will be used for both scaleMin and scaleMax:
<code>setScaleMinMax(1)</code> = scaleMin.x, scaleMin.y, scaleMax.x and scaleMax.y all = 1</p>
<p>If only two parameters are given the first is set as scaleMin.x and y and the second as scaleMax.x and y:
<code>setScaleMinMax(0.5, 2)</code> = scaleMin.x and y = 0.5 and scaleMax.x and y = 2</p>
<p>If you wish to set <code>scaleMin</code> with different values for x and y then either modify Game Object.scaleMin directly,
or pass <code>null</code> for the <code>maxX</code> and <code>maxY</code> parameters.</p>
<p>Call <code>setScaleMinMax(null)</code> to clear all previously set values.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>minX</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>
|

<span class="param-type">null</span>



            
            </td>

            

            

            <td class="description param-description last"><p>The minimum horizontal scale value this Game Object can scale down to.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>minY</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>
|

<span class="param-type">null</span>



            
            </td>

            

            

            <td class="description param-description last"><p>The minimum vertical scale value this Game Object can scale down to.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>maxX</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>
|

<span class="param-type">null</span>



            
            </td>

            

            

            <td class="description param-description last"><p>The maximum horizontal scale value this Game Object can scale up to.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>maxY</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>
|

<span class="param-type">null</span>



            
            </td>

            

            

            <td class="description param-description last"><p>The maximum vertical scale value this Game Object can scale up to.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.ScaleMinMax.html#setScaleMinMax">Phaser.Component.ScaleMinMax#setScaleMinMax</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/ScaleMinMax.js#L109" title="setScaleMinMax on line 109 of src/gameobjects/components/ScaleMinMax.js">src/gameobjects/components/ScaleMinMax.js line 109</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="setSounds" data-name="setSounds">
      <span class="type-signature"></span>setSounds( [overSound] [, overMarker] [, downSound] [, downMarker] [, outSound] [, outMarker] [, upSound] [, upMarker])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Sets the sounds to be played whenever this Button is interacted with. Sounds can be either full Sound objects, or markers pointing to a section of a Sound object.
The most common forms of sounds are 'hover' effects and 'click' effects, which is why the order of the parameters is overSound then downSound.</p>
<p>Call this function with no parameters to reset all sounds on this Button.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>overSound</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Sound.html">Phaser.Sound</a></span>
|

<span class="param-type"><a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a></span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>Over Button Sound.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>overMarker</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>Over Button Sound Marker.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>downSound</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Sound.html">Phaser.Sound</a></span>
|

<span class="param-type"><a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a></span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>Down Button Sound.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>downMarker</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>Down Button Sound Marker.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>outSound</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Sound.html">Phaser.Sound</a></span>
|

<span class="param-type"><a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a></span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>Out Button Sound.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>outMarker</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>Out Button Sound Marker.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>upSound</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Sound.html">Phaser.Sound</a></span>
|

<span class="param-type"><a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a></span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>Up Button Sound.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>upMarker</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>Up Button Sound Marker.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L379" title="setSounds on line 379 of src/gameobjects/Button.js">src/gameobjects/Button.js line 379</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="setTexture" data-name="setTexture">
      <span class="type-signature"></span>setTexture(texture [, destroy])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Sets the texture of the sprite. Be warned that this doesn't remove or destroy the previous
texture this Sprite was using.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>texture</code></td>
            

            <td class="type">
            
                
<span class="param-type">Texture</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description param-description last"><p>The PIXI texture that is displayed by the sprite</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>destroy</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description param-description last"><p>Call Texture.destroy on the current texture before replacing it with the new one?</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.Sprite.html#setTexture">PIXI.Sprite#setTexture</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/Sprite.js#L175" title="setTexture on line 175 of src/pixi/display/Sprite.js">src/pixi/display/Sprite.js line 175</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="setUpSound" data-name="setUpSound">
      <span class="type-signature"></span>setUpSound(sound [, marker])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>The Sound to be played when a Pointer has pressed down and is released from this Button.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sound</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Sound.html">Phaser.Sound</a></span>
|

<span class="param-type"><a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a></span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>The Sound that will be played.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>marker</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>A Sound Marker that will be used in the playback.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/Button.js#L443" title="setUpSound on line 443 of src/gameobjects/Button.js">src/gameobjects/Button.js line 443</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="swapChildren" data-name="swapChildren">
      <span class="type-signature"></span>swapChildren(child, child2)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Swaps the position of 2 Display Objects within this container.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>child</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#DisplayObject">DisplayObject</a></span>



            
            </td>

            

            

            <td class="description param-description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>child2</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#DisplayObject">DisplayObject</a></span>



            
            </td>

            

            

            <td class="description param-description last"></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObjectContainer.html#swapChildren">PIXI.DisplayObjectContainer#swapChildren</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObjectContainer.js#L82" title="swapChildren on line 82 of src/pixi/display/DisplayObjectContainer.js">src/pixi/display/DisplayObjectContainer.js line 82</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="toGlobal" data-name="toGlobal">
      <span class="type-signature"></span>toGlobal(position)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Calculates the global position of this DisplayObject, based on the position given.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>position</code></td>
            

            <td class="type">
            
                
<span class="param-type">PIXI.Point</span>



            
            </td>

            

            

            <td class="description param-description last"><p>The global position to calculate from.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#toGlobal">PIXI.DisplayObject#toGlobal</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L483" title="toGlobal on line 483 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 483</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <ul>
<li>A point object representing the position of this DisplayObject based on the global position given.</li>
</ul>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">PIXI.Point</span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="toLocal" data-name="toLocal">
      <span class="type-signature"></span>toLocal(position [, from])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Calculates the local position of this DisplayObject, relative to another point.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>position</code></td>
            

            <td class="type">
            
                
<span class="param-type">PIXI.Point</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>The world origin to calculate from.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>from</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>An optional DisplayObject to calculate the global position from.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#toLocal">PIXI.DisplayObject#toLocal</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L497" title="toLocal on line 497 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 497</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <ul>
<li>A point object representing the position of this DisplayObject based on the global position given.</li>
</ul>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">PIXI.Point</span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="update" data-name="update">
      <span class="type-signature"></span>update()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Override this method in your own custom objects to handle any update requirements.
It is called immediately after <code>preUpdate</code> and before <code>postUpdate</code>.
Remember if this Game Object has any children you should call update on those too.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Core.html#update">Phaser.Component.Core#update</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Core.js#L343" title="update on line 343 of src/gameobjects/components/Core.js">src/gameobjects/components/Core.js line 343</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="updateCache" data-name="updateCache">
      <span class="type-signature"></span>updateCache()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>If this DisplayObject has a cached Sprite, this method generates and updates it.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#updateCache">PIXI.DisplayObject#updateCache</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L470" title="updateCache on line 470 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 470</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <ul>
<li>A reference to this DisplayObject.</li>
</ul>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<dt>
    <h4 class="name" id="updateCrop" data-name="updateCrop">
      <span class="type-signature"></span>updateCrop()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>If you have set a crop rectangle on this Game Object via <code>crop</code> and since modified the <code>cropRect</code> property,
or the rectangle it references, then you need to update the crop frame by calling this method.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Component.Crop.html#updateCrop">Phaser.Component.Crop#updateCrop</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/gameobjects/components/Crop.js#L85" title="updateCrop on line 85 of src/gameobjects/components/Crop.js">src/gameobjects/components/Crop.js line 85</a>
    

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<dt>
    <h4 class="name" id="updateTransform" data-name="updateTransform">
      <span class="type-signature"></span>updateTransform( [parent])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Updates the transform matrix this DisplayObject uses for rendering.</p>
<p>If the object has no parent, and no parent parameter is provided, it will default to
Phaser.Game.World as the parent transform to use. If that is unavailable the transform fails to take place.</p>
<p>The <code>parent</code> parameter has priority over the actual parent. Use it as a parent override.
Setting it does <strong>not</strong> change the actual parent of this DisplayObject.</p>
<p>Calling this method updates the <code>worldTransform</code>, <code>worldAlpha</code>, <code>worldPosition</code>, <code>worldScale</code>
and <code>worldRotation</code> properties.</p>
<p>If a <code>transformCallback</code> has been specified, it is called at the end of this method, and is passed
the new, updated, worldTransform property, along with the parent transform used.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>parent</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="PIXI.DisplayObjectContainer.html">PIXI.DisplayObjectContainer</a></span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description param-description last"><p>Optional parent to calculate this DisplayObjects transform from.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="PIXI.DisplayObject.html#updateTransform">PIXI.DisplayObject#updateTransform</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.1/src/pixi/display/DisplayObject.js#L291" title="updateTransform on line 291 of src/pixi/display/DisplayObject.js">src/pixi/display/DisplayObject.js line 291</a>
    

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <ul>
<li>A reference to this DisplayObject.</li>
</ul>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>



    </dd>
</dl>


        

    
</dd>

        </dl>
    

    

    
</article>

</section>



</div>
	    <footer class="footer">


<p class="package-signature">
  phaser-ce@2.20.1
  is on
  <a href="https://github.com/photonstorm/phaser-ce/releases/tag/v2.20.1">GitHub</a>
  and
  <a href="https://www.npmjs.com/package/phaser-ce">NPM</a>
</p>





	<p class="copyright">
	Phaser Copyright © 2012-2016 Photon Storm Ltd.
	</p>


<p class="jsdoc-message">
	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
	
		on 2024-10-05
	
	using <a href="https://github.com/photonstorm/phaser-ce/tree/master/resources/docstrap-master">Tomorrow</a>.
</p>

</footer>

		</div>
    
      <div class="toc-container hidden-xs hidden-sm">
  <div class="toc-filter">
    <div class="form-inline">
    <div class="form-group">
      <label for="filter" class="control-label">Filter</label>
      <input type="text" class="form-control" id="toc-filter-input">
    </div>
  </div>
  </div>
  <div id="toc">
    <div class="list-group">
      <div id="toc-insert"></div>
    </div>
  </div>
</div>

    
	</div>
</div>

<script defer src="scripts/bundle.js?2024100511"></script>



</body>
</html>